Create Order

post

https://api.warehance.com/v1/orders

Required permission: write_orders

Create a new order.

Body Params

store_id

integer

required

≥ 1

The ID of the store associated with this order.

shipping_method_id

integer

≥ 1

The ID of the shipping method for this order. Either shipping_method_id or shipping_method_name is required.

shipping_method_name

string

length ≥ 1

The name of the shipping method. If a shipping method with this name does not exist for the store's client, it will be created. Either shipping_method_id or shipping_method_name is required.

warehouse_id

integer

required

≥ 1

The ID of the warehouse fulfilling this order.

api_id

string

length ≥ 1

Custom ID of the order from the marketplace or API. If an order with this API ID already exists, you will receive an error.

shipping_address

object

required

order_number

string

length ≥ 1

An optional custom order number.

reference_number_one

string

length ≤ 255

An optional reference number for the order.

total

float

The total amount of the order.

hold_until_date

date-time

The date and time until which to hold the order.

required_ship_date

date-time

The date by which the order must be shipped. Optional; if not provided, the order will not have a required ship date set.

order_date

date-time

The date and time of the order. If not provided, the current date and time will be used. If provided, it must be in the past.

packing_note

string

A note about the packing of the order.

gift_note

string

A note about the gift of the order.

internal_note

string

A note about the order for internal use.

customs_contents_type

string

enum

The type of contents for customs purposes.

customs_contents_explanation

string

length ≤ 255

An explanation of the contents for customs purposes.

custom_field1

string

length ≤ 255