Skip to main content

DraftOrderInput

Base input for draft orders.

input DraftOrderInput {
billingAddress: AddressInput
user: ID
userEmail: String
shippingAddress: AddressInput
customerNote: String
subStatus: OrderSubStatusEnum @deprecated
}

Fields​

DraftOrderInput.billingAddress ● AddressInput input​

Billing address of the customer.

DraftOrderInput.user ● ID scalar​

Customer associated with the draft order.

DraftOrderInput.userEmail ● String scalar​

Email address of the customer.

DraftOrderInput.shippingAddress ● AddressInput input​

Shipping address of the customer.

DraftOrderInput.customerNote ● String scalar​

A note from a customer. Visible by customers in the order summary.

DraftOrderInput.subStatus ● OrderSubStatusEnum deprecated enum​

DEPRECATED

This will be removed on September 9, 2025.

Sub status the order is to be changed to. Draft orders can have or be given a sub status of AWAITING_PAYMENT. Quote order can have or be given a sub status of either QUOTE_REQUESTED or IN_REVIEW.

Member Of​

draftOrderUpdate mutation

Was this page helpful?