Orders

Making calls to the orders API

Index

Get a list of all orders.

GET/orders

Example Response

Upload Orders

Create new orders in bulk

For this call, you are required to set the merchant using the Merchant Header.

POST/orders/upload

Parameter	Type	Examples	Description
`channel_id` Required	integer	`5`	The ID of the sales channel the orders were placed on
`orders` Required	array<Order>	`[...]`	An array of orders to upload
`orders.*.name` Required	string	`Jane Doe`	The name of the customer that placed the order. Required if first_name and last_name are not set.
`orders.*.first_name` Required	string	`Jane`	The first name of the customer that placed the order. Required if name is not set.
`orders.*.last_name` Required	string	`Doe`	The last name of the customer that placed the order. Required if name is not set.
`orders.*.email` Optional	email	`janedoe@gmail.com`	The email address of the customer that placed the order.
`orders.*.phone` Optional	string	`+1 555 555 5555`	The phone number of the customer that placed the order.
`orders.*.address_line_1` Required	string	`123 Example St`	The first line of the shipping address for the customer that placed the order.
`orders.*.address_line_2` Optional	string	`Apt 2`	The second line of the shipping address for the customer that placed the order.
`orders.*.address_line_3` Optional	string	`C/O John Doe`	The third line of the shipping address for the customer that placed the order.
`orders.*.city` Required	string	`New York`	The city of the shipping address for the customer that placed the order.
`orders.*.state_province` Required	string	`NY`	The province or state of the shipping address for the customer that placed the order.
`orders.*.country` Required	string	`United States`	The country of the shipping address for the customer that placed the order. Required without country_code.
`orders.*.country_code` Required	string	`US`	The country code of the shipping address for the customer that placed the order. Required without country, and is the more reliable way to set the country.
`orders.*.postal_code` Required	string	`21222`	The postal code / ZIP of the shipping address for the customer that placed the order.
`orders.*.is_residential` Optional	boolean	`true`	If the shipping address for the customer that placed the order is a residential address.
`orders.*.order_id` Required	string	`ORDER-ABC-1234`	A unique string that identifies this order
`orders.*.order_date` Optional	date	`2022-03-22`	The date this order was placed
`orders.*.gift_note` Optional	string	`Congratulations!`	A gift note to be included with the order
`orders.*.items` Required	array<Item>	`See the orders..items. parameters`	The items contained in the order
`orders..items..merchant_sku` Required	string	`FLN-A-1554`	The SKU of the item matching. This should be consistent across all channels
`orders..items..quantity` Required	integer	`2`	The quantity of this item that was ordered
`orders..items..title` Required	string	`Wall-mounted Fan Unit, 18 inch`	The title of this item. This will only be used if the item does not already exist on the portal.

Example Response

Show

Get the details of a single order.

GET/orders/{ORDER_ID}

Example Response

Upload Shipping Label

Add a shipping label to an order. This will not add a tracking number to the order and mark it as shipped. This must be done in a separate call.

POST/orders/{ORDER_ID}/uploadShippingLabel

Parameter	Type	Examples	Description
`file` Required	file	`Shipping Label.pdf`	A file containing the shipping labels for the order. The file can be a PDF, PNG, or JPG.

Example Response

Mark as Shipped

Mark an order as shipped and add a tracking number. This will send the tracking number to the marketplace and mark the order as shipped there.

POST/orders/{ORDER_ID}/markAsShipped

Parameter	Type	Examples	Description
`carrier` Required	string	`fedex`	The carrier that was used to ship the order. Valid values: fedex, ups, usps, shippo, canada_post, dhl_express, ontrac, other
`tracking_number` Required	string	`1Z12345E0291980793`	The tracking number for the shipment. This is required if the carrier is set.