Docs
Dashboard

DraftOrder

Object

An administrator-created order that can be edited before it is placed.

#

Fields


availableShippingMethods
[DraftOrderShippingOption!]!

Configured shipping methods whose zones, predicates, currency, and rates are eligible for this draft order. Returns an empty list until the draft has a shipping address.

billingAddress
Address

The billing address associated with this draft order.

createdAt
DateTime!

The date and time when the resource was created.

currency
String!

The currency associated with this draft order.

customerEmail
String

The customer email associated with this draft order.

customerId
ID

The customer id associated with this draft order.

discountCodes
[String!]!

The discount codes associated with this draft order.

id
ID!

The unique identifier of the resource.

lineItems
[DraftOrderLineItem!]!

The line items associated with this draft order.

manualDiscount
DraftOrderManualDiscount

The manual discount associated with this draft order.

metadata
[MetadataItem!]!

The metadata associated with this draft order.

metafields
[Metafield!]!

The metafields associated with this draft order.

order
Order

The order associated with this draft order.

priceChannel
Channel

The price channel associated with this draft order.

shippingAddress
Address

The shipping address associated with this draft order.

shippingLines
[DraftOrderShippingLine!]!

The shipping lines associated with this draft order.

status
DraftOrderStatus!

The status associated with this draft order.

Possible enum values
  • DISCARDED

    The draft was intentionally closed without creating an order.

  • OPEN

    The draft can still be reviewed and changed.

  • PLACED

    The draft has been converted into an order.

store
Store

The store associated with this draft order.

subtotal
Money!

The subtotal associated with this draft order.

taxedPrice
TaxedPrice

The taxed price associated with this draft order.

total
Money!

The total associated with this draft order.

updatedAt
DateTime

The date and time when the resource was last updated.

#

Queries


Runs the draft order operation.

Runs the draft orders operation.

#

Mutations


Runs the draft order create operation.

Runs the draft order custom line items add operation.

Runs the draft order custom shipping lines set operation.

Runs the draft order discard operation.

Runs the draft order discount code add operation.

Runs the draft order discount codes remove operation.

Runs the draft order line item pricing reset operation.

Runs the draft order line item pricing set operation.

Runs the draft order line items add operation.

Runs the draft order line items update operation.

Runs the draft order manual discount remove operation.

Runs the draft order manual discount set operation.

Applies an eligible configured shipping method and its current applicable rate to a draft order.

Runs the draft order update operation.