addDraftOrder
View as MarkdownCreate a new draft order
mutation
Requires one of commerce.order:create, commerce.order:update, commerce.order:cancel, or commerce.order:complete (use the scope that matches the operation).
Create a new draft order
Required headers
| Header | Required | Description |
|---|---|---|
x-store-id | Yes | ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: extensions.code: "UNAUTHENTICATED". |
Go to Authentication for credential setup.
Arguments
inputAddDraftOrderInput!requiredcontextOrderContextInput!requiredbillingOrderBillingInfoInputoptionalcanceledAtDateTimeoptionalcartIdStringoptionalcompletedAtDateTimeoptionalcustomerIdStringoptionaldiscounts[DiscountInput!]optionalexternalIdStringoptionalfees[FeeInput!]optionalfulfilledAtDateTimeoptionalfulfillmentModes[String!]optional — Automatically set based on lineItem fulfillment modes. This field is read-only.inventoryActionInventoryActionoptionallineItems[CreateDraftLineItemInput!]optionalmetafields[OrderMetafieldInput!]optionalnotes[NoteInput!]optionalnumberStringoptionalnumberDisplayStringoptionalpaidAtDateTimeoptionalrefundedAtDateTimeoptionalshippingOrderShippingInfoInputoptionalshippingLines[ShippingLineInput!]optionalstaffUserIds[String!]optionaltags[String!]optionaltaxes[OrderTaxInput!]optionaltaxExemptedBooleanoptionaltotalsOrderTotalsInputoptional — Deprecated: Totals are now auto-calculated and should not be manually settransactionIds[String!]optional
Possible returns
OrderOrder
Last updated on
How is this guide?