Create an Order

Time	Status	User Agent
Retrieving recent requests…

Body Params

address

object

required

Address for order delivery. Dreamship will attempt to verify all addresses before accepting order.

line_items

array of objects

required

A list of all products you want fulfilled.

line_items*

reference_id

string | null

A unique ID that you provide to track orders. Dreamship will raise an error if you have any other non-cancelled orders with the same reference_id.

shipping_method

string

enum

Shipping Method can be either economy, or express. Additional charges for faster shipping will apply.

Allowed:

shop_key

string

Key of the shop associated with the order.

test_order

boolean

Set to True to mark as a test order. Test orders will not be billed or fulfilled. You will be able to see test orders on your Dreamship dashboard

vat_currency

string

enum

Input GBP, EUR or CHF if you have set a Tax Number. Leave it out for orders to Mexico.

Allowed:

vat_number

string

length ≤ 500

Add a VAT number for UK addresses or an IOSS number for EU addresses. Required for addresses in Mexico: the recipient's RFC or CURP.

webhook_url

uri | null

^(?:[a-z0-9.+-]*)://(?:[^\s:@/]+(?::[^\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z¡-0-9](?:[a-z¡-0-9-]{0,61}[a-z¡-0-9])?(?:\.(?!-)[a-z¡-0-9-]{1,63}(?<!-))*\.(?!-)(?:[a-z¡--]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\s]*)?\z

Order data is posted to this url whenever the order's status changes, in addition to the webhook URLs in your API settings. Each address gets each event once. View the Webhooks page for signing and retries.

rush_production

boolean

Deprecated. Use forty_eight_hour_fulfillment

forty_eight_hour_fulfillment

boolean

If possible with the order line items, this order will have expedited tracking numbers for TikTok Compliance at an additional cost.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

201