AdminPostDraftOrdersReq

Properties

billing_addressstring | AddressPayload

The Address to be used for billing purposes.

customer_idstring

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

discountsDiscount[]

The discounts to add to the draft order

emailstringRequired

The email of the customer of the draft order

itemsItem[]

The draft order's line items.

metadataRecord<string, unknown>

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

no_notification_orderboolean

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

region_idstringRequired

The ID of the region for the draft order

shipping_addressstring | AddressPayload

The Address to be used for shipping purposes.

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.