Create a Draft Order

Create a Draft Order. A draft order is not transformed into an order until payment is captured.

curl --location -g --request POST '{{BASE_URL}}/admin/draft-orders' \ --header 'Content-Type: application/json' \ --data-raw '{ "email": "user@example.com", "region_id": "string", "customer_id": "string", "no_notification_order": true, "status": "open", "metadata": {}, "discounts": [ { "code": "string" } ], "shipping_methods": [ { "option_id": "string", "data": {}, "price": 0 } ], "items": [ { "variant_id": "string", "unit_price": 0, "title": "string", "quantity": 0, "metadata": {} } ], "billing_address": { "first_name": "Arno", "last_name": "Willms", "phone": 16128234334802, "company": "string", "address_1": "14433 Kemmer Court", "address_2": "Suite 369", "city": "South Geoffreyview", "province": "Kentucky", "postal_code": 72093, "country_code": "st", "metadata": { "car": "white" } }, "shipping_address": { "first_name": "Arno", "last_name": "Willms", "phone": 16128234334802, "company": "string", "address_1": "14433 Kemmer Court", "address_2": "Suite 369", "city": "South Geoffreyview", "province": "Kentucky", "postal_code": 72093, "country_code": "st", "metadata": { "car": "white" } } }'

{ "draft_order": { "id": "dorder_01G8TJFKBG38YYFQ035MSVG03C", "display_id": 2, "cart_id": "cart_01G8ZH853Y6TFXWPG5EYE81X63", "cart": {}, "order_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK", "order": {}, "canceled_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "no_notification_order": false, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "status": "open", "idempotency_key": "string", "metadata": { "car": "white" } } }

Request

Body Params application/json

string <email>

required

The email of the customer of the draft order

region_id

string

required

The ID of the region for the draft order

customer_id

string

optional

The ID of the customer this draft order is associated with.

no_notification_order

boolean

optional

An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates.

status

enum<string>

optional

The status of the draft order. The draft order's default status is open. It's changed to completed when its payment is marked as paid.

Allowed values:

opencompleted

metadata

object

optional

The optional key-value map with additional details about the Draft Order.

discounts

array [object {1}]

optional

The discounts to add to the draft order

code

string

required

The code of the discount to apply

shipping_methods

array [object {3}]

required

The shipping methods for the draft order

option_id

string

required

The ID of the shipping option in use

data

object

optional

The optional additional data needed for the shipping method

price

integer

optional

The price of the shipping method.

items

array [object {5}]

optional

The draft order's line items.

variant_id

string

optional

The ID of the Product Variant associated with the line item. If the line item is custom, the variant_id should be omitted.

unit_price

integer

optional

The custom price of the line item. If a variant_id is supplied, the price provided here will override the variant's price.

title

string

optional

The title of the line item if variant_id is not provided.

quantity

integer

required

The quantity of the line item.

metadata

object

optional

The optional key-value map with additional details about the line item.

billing_address

optional

The Address to be used for billing purposes.

Any of

AddressPayload

string

Address fields used when creating/updating an address.

first_name

string

optional

First name

Example:

Arno

last_name

string

optional

Last name

Example:

Willms

phone

string

optional

Phone Number

Example:

16128234334802

company

string

optional

address_1

string

optional

Address line 1

Example:

14433 Kemmer Court

address_2

string

optional

Address line 2

Example:

Suite 369

city

string

optional

City

Example:

South Geoffreyview

province

string

optional

Province

Example:

Kentucky

postal_code

string

optional

Postal Code

Example:

72093

country_code

string

optional

The 2 character ISO code of the country in lower case

Example:

metadata

object

optional

An optional key-value map with additional details

Example:

{"car":"white"}

shipping_address

optional

The Address to be used for shipping purposes.

Any of

AddressPayload

string

Address fields used when creating/updating an address.

first_name

string

optional

First name

Example:

Arno

last_name

string

optional

Last name

Example:

Willms

phone

string

optional

Phone Number

Example:

16128234334802

company

string

optional

address_1

string

optional

Address line 1

Example:

14433 Kemmer Court

address_2

string

optional

Address line 2

Example:

Suite 369

city

string

optional

City

Example:

South Geoffreyview

province

string

optional

Province

Example:

Kentucky

postal_code

string

optional

Postal Code

Example:

72093

country_code

string

optional

The 2 character ISO code of the country in lower case

Example:

metadata

object

optional

An optional key-value map with additional details

Example:

{"car":"white"}

Examples

Responses

🟢200OK

application/json

Body

draft_order

object (DraftOrder)

required

A draft order is created by an admin without direct involvement of the customer. Once its payment is marked as captured, it is transformed into an order.

string

required

The draft order's ID

Example:

dorder_01G8TJFKBG38YYFQ035MSVG03C

display_id

string

required

The draft order's display ID

Example:

cart_id

string | null

required

The ID of the cart associated with the draft order.

Example:

cart_01G8ZH853Y6TFXWPG5EYE81X63

cart

object | null

optional

The details of the cart associated with the draft order.

order_id

string | null

required

The ID of the order created from the draft order when its payment is captured.

Example:

order_01G8TJSYT9M6AVS5N4EMNFS1EK

order

object | null

optional

The details of the order created from the draft order when its payment is captured.

canceled_at

string <date-time> | null

required

The date the draft order was canceled at.

completed_at

string <date-time> | null

required

The date the draft order was completed at.

no_notification_order

boolean | null

required

Whether to send the customer notifications regarding order updates.

Example:

false

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

status

enum<string>

required

The status of the draft order. It's changed to completed when it's transformed to an order.

Allowed values:

opencompleted

Default:

open

idempotency_key

string | null

required

Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error