Skip to main content
Skip to main content

AdminPostDraftOrdersReq

The details of the draft order to create.

Properties

emailstringRequired
The email of the customer of the draft order
region_idstringRequired
The ID of the region for the draft order
shipping_methodsShippingMethod[]Required
The shipping methods for the draft order
statusstring
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.
billing_addressstring | AddressPayload
The Address to be used for billing purposes.
shipping_addressstring | AddressPayload
The Address to be used for shipping purposes.
itemsItem[]
The draft order's line items.
discountsDiscount[]
The discounts to add to the draft order
customer_idstring
The ID of the customer this draft order is associated with.
no_notification_orderboolean
An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates.
metadataRecord<string, unknown>
The optional key-value map with additional details about the Draft Order.

Default: {}

Was this section helpful?