| Name | Description | Type | Additional information |
|---|---|---|---|
| order_po |
This be a unique order identifier or reference number. For example, an order numnber generated by your shopping cart or application. If you are just calculating shipping or testing any random string or number will suffice |
text | |
| order_key |
This should be left as null. It will be generated when the order is submitted. |
globally unique identifier |
None. |
| recipient |
Name and address of address you want order sent to. |
address |
Required |
| order_items |
A list of individual products based on sku to be processed and shipped with order. |
array (product) |
Required |
| shipping_code |
Shipping code that must be included with any orders. Will be required when submitting an order. Use the list_shipping_options to get specific codes or enter one of these codes: EC = Economy (Cheapest), SD = UPS Ground, FS = Fastest Availabled |
text |
Required |
| ship_by_date |
Optional date it needs to ship by |
date |
None. |
| customs_tax_info |
Optional for customs tax id and type whe shipping internationally |
customs_tax_info |
None. |
| gift_message |
Optional message to print out on the packing slip for the recipient to see. |
text |
None. |
| test_mode |
Optional - You can flag this order as a test order. Default is false if left empty or not included. |
boolean |
None. |
| webhook_order_status_url |
Optional - order status webhook. Location were we can post JSON object with order status details. See fetch_order_status response (orders) for json format. |
text |
None. |
| document_url |
May be a single page document. Must be a JPG or PDF (8.5x11) |
text |
Max length: 200 |
| acct_number_ups |
FinerWorks registered UPS account. Used to ship under your own account. |
text |
Max length: 50 |
| acct_number_fedex |
FinerWorks registered FEDEX account. Used to ship under your own account. |
text |
Max length: 50 |
| custom_data_1 |
Optional data which may be used by developers. |
text |
Max length: 255 |
| custom_data_2 |
Optional data which may be used by developers. |
text |
Max length: 255 |
| custom_data_3 |
Optional data which may be used by developers. |
text |
Max length: 255 |