Create an Order

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Allowed:

vat_number

string

length ≤ 500

Add a VAT number for UK addresses or an IOSS number for EU addresses.

webhook_url

uri | null

Order data will be sent to this url on status changes. View webhook tab for more instructions.

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:

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201