Skip to main content
POST
Create Order

Create Order

Creates a new order programmatically — for importing orders from external systems or recording orders taken elsewhere. Requires the write_orders scope. The body can be flat or wrapped in { "order": { ... } }.
Totals are taken from what you send: the subtotal is each line item’s price × quantity, plus the shipping_lines prices. There is no inventory deduction, no discount-code resolution and no tax calculation on this endpoint. The order is pending unless you send financial_status: "paid".

Request

Body Parameters

Any field not listed below is ignored.
array
required
Line items for the order.
string
ISO 4217 code of the prices you send, stored as the order currency. Defaults to the store’s currency. It must be the store’s currency or the currency of a country the store sells to — anything else is rejected with 422, the same rule as checkout.
string
paid creates a paid order (and fires orders/paid); anything else creates a pending one.
string
default:"Other"
Name of the payment gateway the order was paid through.
string
Order contact email. Defaults to customer.email.
object
Customer information. customer.email becomes the order email and the customer name is derived from first_name / last_name.
object
Shipping address for the order.
object
Billing address, same shape as shipping_address. When omitted, the order’s billing address is its shipping address.
array
Shipping charged: [{ "title": "Standard", "code": "std", "price": "5.00" }]. The prices are added to the total.
string
Order note.
array
Accepted but not stored — orders have no tags.

Response

On success (201 Created) the order is returned under order — the same shape as Get Order. It gets its own order number (order_number, shown as name #<number>). Money fields are decimal strings. orders/create fires, plus orders/paid for a paid order.

Example Response

Errors are returned as a standard { errors } body:

Error Codes