| 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. |