7d650771d1
* add new plugin for better organization * added handling in theme for mutations and query types * added tsdoc to hooks * added tsdocs to utility functions * added tsdoc to providers * generated reference * general fixes for generated reference * generated api reference specs + general fixes * add missing import react * split utilities into different directories * added overview page * added link to customer authentication section * fix lint errors * added changeset * fix readme * fixed build error * added expand fields + other sections to overview * updated what's new section * general refactoring * remove unnecessary query field * fix links * added ignoreApi option
65 lines
1.8 KiB
YAML
65 lines
1.8 KiB
YAML
type: object
|
|
description: The details to update of the order.
|
|
properties:
|
|
email:
|
|
description: The email associated with the order
|
|
type: string
|
|
billing_address:
|
|
description: The order's billing address
|
|
$ref: ./AddressPayload.yaml
|
|
shipping_address:
|
|
description: The order's shipping address
|
|
$ref: ./AddressPayload.yaml
|
|
items:
|
|
description: The line items of the order
|
|
type: array
|
|
items:
|
|
$ref: ./LineItem.yaml
|
|
region:
|
|
description: ID of the region that the order is associated with.
|
|
type: string
|
|
discounts:
|
|
description: The discounts applied to the order
|
|
type: array
|
|
items:
|
|
$ref: ./Discount.yaml
|
|
customer_id:
|
|
description: The ID of the customer associated with the order.
|
|
type: string
|
|
payment_method:
|
|
description: The payment method chosen for the order.
|
|
type: object
|
|
properties:
|
|
provider_id:
|
|
type: string
|
|
description: The ID of the payment provider.
|
|
data:
|
|
description: Any data relevant for the given payment method.
|
|
type: object
|
|
shipping_method:
|
|
description: The Shipping Method used for shipping the order.
|
|
type: object
|
|
properties:
|
|
provider_id:
|
|
type: string
|
|
description: The ID of the shipping provider.
|
|
profile_id:
|
|
type: string
|
|
description: The ID of the shipping profile.
|
|
price:
|
|
type: integer
|
|
description: The price of the shipping.
|
|
data:
|
|
type: object
|
|
description: Any data relevant to the specific shipping method.
|
|
items:
|
|
type: array
|
|
items:
|
|
$ref: ./LineItem.yaml
|
|
description: Items to ship
|
|
no_notification:
|
|
description: >-
|
|
If set to `true`, no notification will be sent to the customer related to
|
|
this order.
|
|
type: boolean
|