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
id
stringRequiredThe draft order's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
The status of the draft order. It's changed to
completed
when it's transformed to an order.Default: open
display_id
numberRequiredThe draft order's display ID
cart_id
stringRequiredThe ID of the cart associated with the draft order.
The details of the cart associated with the draft order.
order_id
stringRequiredThe ID of the order created from the draft order when its payment is captured.
The details of the order created from the draft order when its payment is captured.
canceled_at
DateRequiredThe date the draft order was canceled at.
completed_at
DateRequiredThe date the draft order was completed at.
no_notification_order
booleanRequiredWhether to send the customer notifications regarding order updates.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
idempotency_key
stringRequiredRandomly generated key used to continue the completion of the cart associated with the draft order in case of failure.
Was this section helpful?