NameDescriptionTypeAdditional 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 your are just calculating shipping or testing any random string or number will suffice

text

order_key

Billing information. Must be left empty or null. Will be populated by account on file.

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

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