Create Outbound Order

This API describes how to create an outbound order.

Method: POST

Request Body

json

{
  "reference_no": "abc123",
  "warehouse_code": "LAX01W",
  "shipping_method": "STANDARD",
  "ship_to": {
    "name": "shipper name",
    "company_name": "",
    "address_1": "123 First St.",
    "address_2": "",
    "city": "Anytown",
    "state": "CA",
    "country": "US",
    "zip": "90210",
    "phone": "1234567890",
    "email": "help@email.com"
  },
  "order_products": [
    {
      "sku": "sku-1",
      "quantity": 2,
      "unit_price": 12.95,
      "currency": "USD"
    },
    {
      "sku": "sku-2",
      "quantity": 1,
      "unit_price": 9.95,
      "currency": "USD"
    }
  ]
}

Request Body Explanation

Attribute Name	Type	Description
reference_no	String	Reference Number, must be unique and length>=4
warehouse_code	String	code of outbound warehouse
shipping_method	String	shipping method code
ship_to	Object	object of recipient
company_name	String	name of the recipient's company
name	String	name of the recipient
address_1	String	the first line of recipient's address
address_2	String	the second line of recipient's address
city	String	city name of the recipient
state	String	state name of the recipient
zip	String	zip code of the recipient
country	String	country of the recipient
phone	String	phone number of the recipient
email	String	email address of the recipient
order_products	List	list of outbound products
sku	String	sku number of outbound product
quantity	Integer	quantity of outbound product
unit_price	Float	price for each product
currency	String	currency of the product price, only support 'USD' for now

Response Body

json

{
  "code": 200,
  "message": "success"
}

Response Body Explanation

Attribute Name	Type	Description
code	Integer	Response code: 200 successful, 400/500 failed
message	String	message of the result of outbound order creation