Description
Modify an order.
While this API follows "multiple objects" convention, operations only on one order are allowed at a time.
Topic: Orders
Arguments
data: [StorefrontOrderModify!]!
Main argument for mutations.
List of order ids. See also: Unique Identifiers
Example: ["or_EQzGqWoY"]
Unique shop identifier. See also: Unique Identifiers
Example: "sh_EQzGqWoY"
Data Argument Fields
billing_address: AddressCreate
Billing address of an order
billing_address_short_id: String
Billing address of an order (short)
Example: "ar_EQzGqWoY"
Valid when: billing_address_short_id matches regexp pattern: ^ar_
Currency to calculate the order in
Example: "USD"
Customer email, used in no auth order flows
Example: "Customer email, used in no auth order flows"
Customer id order belongs to, must be your customer id (specify this parameter to convert anonymous order to customer order)
Example: "cu_EQzGqWoY"
Valid when: customer_id matches regexp pattern: ^cu_
A discount code that can be entered by a customer on checkout
Example: "AD1241251"
Gateway used
Example: "gw_EQzGqWoY"
Valid when: gateway_id matches regexp pattern: ^gw_
line_items: [OrderLineItemCreate!]
Order line items
The mobile phone number of the customer (used for notifications)
Example: "45634634562"
Whether to notify customer via mobile phone or not
Example: false
send_fulfillment_notifications: Boolean
Should customer receive fulfillment-related notifications or not
Example: false
send_order_notifications: Boolean
Should customer receive order-related notifications or not
Example: false
shipping_address: AddressCreate
Shipping address of an order
shipping_address_short_id: String
Shipping address of an order (short)
Example: "ar_EQzGqWoY"
Valid when: shipping_address_short_id matches regexp pattern: ^ar_
Result
Preview (typescript)
Loading module