Description

Topic: Orders

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_

clone_from_id: String

Valid order id to clone from, if used all other parameters are ignored

Example: "or_EQzGqWoY"

Valid when: clone_from_id matches regexp pattern: ^or_

currency: String

Currency to calculate the order in

Example: "USD"

customer_email: String

Customer email, used in no auth order flows

Example: "Customer email, used in no auth order flows"

customer_id: String

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_

discount_code: String

A discount code that can be entered by a customer on checkout

Example: "AD1241251"

gateway_id: String

Gateway used

Example: "gw_EQzGqWoY"

Valid when: gateway_id matches regexp pattern: ^gw_

line_items: [OrderLineItemCreate!]

Order line items

mobile: String

The mobile phone number of the customer (used for notifications)

Example: "45634634562"

mobile_notifications: Boolean

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_

shipping_rate_ids: [String!]

Used By

Mutations

storefrontOrdersCreate

Preview (typescript)

interface StorefrontOrderCreate {
billing_address?: AddressCreate | null
billing_address_short_id?: string
clone_from_id?: string
currency?: string
customer_email?: string
customer_id?: string
discount_code?: string
gateway_id?: string
line_items?: OrderLineItemCreate[]
mobile?: string
mobile_notifications?: boolean
send_fulfillment_notifications?: boolean
send_order_notifications?: boolean
shipping_address?: AddressCreate | null
shipping_address_short_id?: string
shipping_rate_ids?: string[]
}