DraftOrder

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.

Properties

idstringRequired

The draft order's ID

created_atDateRequired

The date with timezone at which the resource was created.

updated_atDateRequired

The date with timezone at which the resource was updated.

statusDraftOrderStatusRequired

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

Default: open

display_idnumberRequired

The draft order's display ID

cart_idstringRequired

The ID of the cart associated with the draft order.

cartCartRequired

The details of the cart associated with the draft order.

order_idstringRequired

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

orderOrderRequired

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

canceled_atDateRequired

The date the draft order was canceled at.

completed_atDateRequired

The date the draft order was completed at.

no_notification_orderbooleanRequired

Whether to send the customer notifications regarding order updates.

metadataRecord<string, unknown>Required

An optional key-value map with additional details

idempotency_keystringRequired

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