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.

Constructors

constructor

**new 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

canceled_atDateRequired

The date the draft order was canceled at.

cartCartRequired

The details of the cart associated with the draft order.

cart_idstringRequired

The ID of the cart associated with the draft order.

completed_atDateRequired

The date the draft order was completed at.

created_atDateRequired

The date with timezone at which the resource was created.

display_idnumberRequired

The draft order's display ID

idstringRequired

The draft order's ID

idempotency_keystringRequired

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

metadataRecord<string, unknown>Required

An optional key-value map with additional details

no_notification_orderbooleanRequired

Whether to send the customer notifications regarding order updates.

orderOrderRequired

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

order_idstringRequired

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

statusDraftOrderStatusRequired

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

Default: open

updated_atDateRequired

The date with timezone at which the resource was updated.

Methods

beforeInsert

Private **beforeInsert**(): Promise<void>

Returns

Promise<void>

PromisePromise<void>Required