AdminPostDraftOrdersReq
The details of the draft order to create.
Properties
email
stringRequiredThe email of the customer of the draft order
region_id
stringRequiredThe ID of the region for the draft order
The shipping methods for the draft order
status
stringThe 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.billing_address
string | AddressPayloadThe Address to be used for billing purposes.
shipping_address
string | AddressPayloadThe Address to be used for shipping purposes.
items
Item[]The draft order's line items.
items
Item[]discounts
Discount[]The discounts to add to the draft order
discounts
Discount[]customer_id
stringThe ID of the customer this draft order is associated with.
no_notification_order
booleanAn optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates.
metadata
Record<string, unknown>The optional key-value map with additional details about the Draft Order.
Default: {}
Was this section helpful?