GET order_items/{id}
Returns order_items object by your order id (string) for checking order status and shipping updates. Please pass the API signature into the x-api-key HTTP header.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns order_items object by your order id (string) for checking order status and shipping updates. Please pass the API signature into the x-api-key HTTP header.
order_items| Name | Description | Type | Additional information |
|---|---|---|---|
| api_signature |
API signature provided by Teamwork |
string |
Required |
| order_id |
Your order id, accepting alpha numeric characters |
string |
String length: inclusive between 0 and 40 |
| po_number |
Purchase order number |
string |
String length: inclusive between 0 and 20 |
| reference |
Reference number |
string |
String length: inclusive between 0 and 40 |
| status |
Order status we return to you ( accepted, manufacturing, shipping, shipped, bad_address, cancelled) |
string |
None. |
| status_description |
Extra information available for current order status. |
string |
String length: inclusive between 0 and 512 |
| promise_date |
The date when order is promised to be shipped |
date |
None. |
| mfg_time |
Requested manufacturing time in business days (3,5,10). Extra fee may apply. |
integer |
None. |
| shipping_address |
Drop ship address. |
Address |
Required |
| shipping_carrier |
Shipping carrier (USPS,UPS,FedEx) |
string |
Required |
| shipping_account |
3rd Party Billing Account for shipping carrier |
string |
String length: inclusive between 0 and 60 |
| shipping_method |
Valid shipping methods per carrier are: for USPS ('First', 'Priority', 'INTERNATIONAL_PRIORITY') where 'Priority' is Priority Mail, 'First' is First-Class Mail for packages up to 13 oz otherwise it will be automatically flipped to Priority Mail, 'INTERNATIONAL_PRIORITY' is Priority Mail International, for UPS ('UPS Ground','UPS 3 Day Select','UPS 2nd Day Air','UPS Next Day Air Saver','UPS Next Day Air'), for FedEx ('FedEx Ground','FedEx Second Day Air','Fedex Next Day Air Saver','FedEx Next Day Air','FEDEX_INTL_MAILSERVICE') where 'FEDEX_INTL_MAILSERVICE' is FedEx International MailService. |
string |
String length: inclusive between 0 and 40 |
| tracking_number |
Tracking number returned here once we shipped the order. |
string |
String length: inclusive between 0 and 80 |
| items |
Ordered products |
Collection of Item |
Required |
| id |
Legacy order id, 64 bit integer, remains for compatibility with older integrations and will be deprecated in future release |
integer |
None. |
| M3OrderNumber |
Intercompany order number |
string |
None. |
Response Formats
application/json, text/json
{
"api_signature": "sample string 1",
"order_id": "sample string 2",
"po_number": "sample string 3",
"reference": "sample string 4",
"status": "sample string 5",
"status_description": "sample string 6",
"promise_date": "2025-11-05T19:48:23.622861-08:00",
"mfg_time": 8,
"shipping_address": {
"full_name": "sample string 1",
"address_line_1": "sample string 2",
"address_line_2": "sample string 3",
"address_line_3": "sample string 4",
"address_line_4": "sample string 5",
"postcode": "sample string 6",
"country": "sample string 7",
"phone": "sample string 8"
},
"shipping_carrier": "sample string 9",
"shipping_account": "sample string 10",
"shipping_method": "sample string 11",
"tracking_number": "sample string 12",
"items": [
{
"sku": "sample string 1",
"quantity": 2,
"consumer_price": 3.0,
"print_ready_url": "sample string 4",
"preview_url": "sample string 5",
"attributes": {
"size": "sample string 1",
"thread_color": "sample string 2",
"zipper_color": "sample string 3",
"drawstring_color": "sample string 4",
"neck_tape_color": "sample string 5",
"woven_label": "sample string 6",
"player_name": "sample string 7",
"player_number": "sample string 8"
}
},
{
"sku": "sample string 1",
"quantity": 2,
"consumer_price": 3.0,
"print_ready_url": "sample string 4",
"preview_url": "sample string 5",
"attributes": {
"size": "sample string 1",
"thread_color": "sample string 2",
"zipper_color": "sample string 3",
"drawstring_color": "sample string 4",
"neck_tape_color": "sample string 5",
"woven_label": "sample string 6",
"player_name": "sample string 7",
"player_number": "sample string 8"
}
}
],
"id": 13,
"M3OrderNumber": "sample string 14"
}
application/xml, text/xml
<order_items xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OrdersAPI.Models">
<M3OrderNumber>sample string 14</M3OrderNumber>
<api_signature>sample string 1</api_signature>
<id>13</id>
<items>
<Item>
<attributes>
<drawstring_color>sample string 4</drawstring_color>
<neck_tape_color>sample string 5</neck_tape_color>
<player_name>sample string 7</player_name>
<player_number>sample string 8</player_number>
<size>sample string 1</size>
<thread_color>sample string 2</thread_color>
<woven_label>sample string 6</woven_label>
<zipper_color>sample string 3</zipper_color>
</attributes>
<consumer_price>3</consumer_price>
<preview_url>sample string 5</preview_url>
<print_ready_url>sample string 4</print_ready_url>
<quantity>2</quantity>
<sku>sample string 1</sku>
</Item>
<Item>
<attributes>
<drawstring_color>sample string 4</drawstring_color>
<neck_tape_color>sample string 5</neck_tape_color>
<player_name>sample string 7</player_name>
<player_number>sample string 8</player_number>
<size>sample string 1</size>
<thread_color>sample string 2</thread_color>
<woven_label>sample string 6</woven_label>
<zipper_color>sample string 3</zipper_color>
</attributes>
<consumer_price>3</consumer_price>
<preview_url>sample string 5</preview_url>
<print_ready_url>sample string 4</print_ready_url>
<quantity>2</quantity>
<sku>sample string 1</sku>
</Item>
</items>
<mfg_time>8</mfg_time>
<order_id>sample string 2</order_id>
<po_number>sample string 3</po_number>
<promise_date>2025-11-05T19:48:23.622861-08:00</promise_date>
<reference>sample string 4</reference>
<shipping_account>sample string 10</shipping_account>
<shipping_address>
<address_line_1>sample string 2</address_line_1>
<address_line_2>sample string 3</address_line_2>
<address_line_3>sample string 4</address_line_3>
<address_line_4>sample string 5</address_line_4>
<country>sample string 7</country>
<full_name>sample string 1</full_name>
<phone>sample string 8</phone>
<postcode>sample string 6</postcode>
</shipping_address>
<shipping_carrier>sample string 9</shipping_carrier>
<shipping_method>sample string 11</shipping_method>
<status>sample string 5</status>
<status_description>sample string 6</status_description>
<tracking_number>sample string 12</tracking_number>
</order_items>