Order
The order’s details, including information about the products or services rendered, customer service, and fulfillment.
Declaration
object OrderProperties
| Name | Type | Description |
|---|---|---|
createdAt Required | date-time | The date and time when the customer created the order, in RFC 3339 format. |
merchant Required | Merchant | The merchant for this order. |
orderIdentifier Required | string | A unique order identifier scoped to your order type identifier. In combination with the order type identifier, this uniquely identifies an order within the system and isn’t displayed to the user. |
orderManagementURL Required | uri | A URL where the customer can manage the order. |
orderType Required | string | The type of order this bundle represents. Currently the only supported value is |
orderTypeIdentifier Required | string | An identifier for the order type associated with the order. The value must correspond with your signing certificate and isn’t displayed to the user. |
status Required | string | A high-level status of the order, used for display purposes. The system considers orders with status |
schemaVersion Required | number | The version of the schema used for the order. The current version is |
updatedAt Required | date-time | The date and time when the order was last updated, in RFC 3339 format. This should equal the |
associatedApplications | [Application] | A list of associated applications, in order of preference. The device uses the first available application. |
associatedApplicationIdentifiers | [string] | The application identifier associated with the order. |
authenticationToken | string | The authentication token supplied to your web service. Required if you provide a web service. |
barcode | Barcode | An identifier containing information about an order. |
changeNotifications | string | A property that describes whether the device notifies the user about relevant changes to the order. The default is |
customer | Customer | The customer for this order. |
fulfillments | [*] | A list of fulfillments. The device displays fulfillments in the order provided. |
lineItems | [LineItem] | The items contained in the order, displayed in the order provided. |
orderNumber | string | If available, an order number or reference suitable for display to the user. |
orderProvider | OrderProvider | Information about the platform providing the order data. Use this field if the order data isn’t provided by the merchant, but by a third party. |
payment | Payment | The payment for this order. |
returnInfo | ReturnInfo | The information related to a partial or full return. |
returns | [Return] | A list of returns. The device displays returns in the order provided. |
statusDescription | string | A localized message describing the order status. |
webServiceURL | uri | The URL of your web service. This must begin with |