Draft Order Create Payload
Return type for mutation.
Anchor to FieldsFields
- draftOrder (DraftOrder)
- userErrors ([UserError!]!)
- Anchor to draftOrderdraft•Draft
Order Order The created draft order.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- draftOrderCreate (DraftOrderCreatePayload)
- •mutation
Creates a draft order with attributes such as customer information, line items, shipping and billing addresses, and payment terms. Draft orders are useful for merchants that need to:
- Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
- Send invoices to customers with a secure checkout link.
- Use custom items to represent additional costs or products not in inventory.
- Re-create orders manually from active sales channels.
- Sell products at discount or wholesale rates.
- Take pre-orders.
After creating a draft order, you can:
- Send an invoice to the customer using the
mutation. - Complete the draft order using the
mutation. - Update the draft order using the
mutation. - Duplicate a draft order using the
mutation. - Delete the draft order using the
mutation.
NoteWhen you create a draft order, you can't reserve or hold inventory for the items in the order by default. However, you can reserve inventory using the
input.Note:When you create a draft order, you can't reserve or hold inventory for the items in the order by default. However, you can reserve inventory using the
input.Note: When you create a draft order, you can't <a href="https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps#inventory-states">reserve or hold inventory</a> for the items in the order by default. However, you can reserve inventory using the <a href="https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderCreate#arguments-input.fields.reserveInventoryUntil"><code><span class="PreventFireFoxApplyingGapToWBR">reserve<wbr/>Inventory<wbr/>Until</span></code></a> input.
- Anchor to inputinput•Draft
Order Input! required The fields used to create the draft order.
Arguments