An order is a full object containing information about an order. An order is created when a customer completes the checkout process, during which time a customer, billing address, products, shipping methods, shipments and discounts is created.
| Property | Description | Required | Data Type |
|---|---|---|---|
| order_number | A unique identifier of the order. | True | String |
| order_created_at | The date and time when the order was created. ISO 8601 format required: '2017-10-25T11: 34:26+00:00' | True | String |
| total_price | The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). | False | Decimal |
| subtotal_price | Price of the order before shipping and taxes | False | Decimal |
| total_shipping_price | Total Price of Shipping | False | Decimal |
| total_tax | The sum of all the taxes applied to the order (must be positive). | False | Decimal |
| tax_rate | The tax rate applied to the whole order (must be positive). | False | Decimal |
| currency | The three letter code (ISO 4217) for the currency used for the payment. | False | String |
| partner_id | Order Source ID. | False | String |
| shipping_methods | A List of shipping method objects, each with details of the shipping method used. | True | ShippingMethod |
| shipments | Shipment containing the shipping address, Allowing part shipment if necessary. | True | Shipment |
| customer | An object containing information about the customer. | True | Customer |
| billing_address | The billing address of the Order. | False | BillingAddress |
| order_offers | List of order offers. Can be of: InputDiscount, OutputDiscount & ReferDiscount. | False | List<OrderOffer> |
| products | A list of products within the order, each one containing information about a product in the order. | True | List<Product> |
| recommendations | List of recommendations for the product. | False | List<Recommendation> |
| language | Current locale or language used on the store. | False | String |
| reviews | List of reviews for the product. | False | List<Review> |
| Tags | Order Tags. | False | String |
| custom_1 | A Custom Field for additional data. | False | String |
| custom_2 | A Custom Field for additional data. | False | String |
| custom_3 | A Custom Field for additional data. | False | String |
| custom_4 | A Custom Field for additional data. | False | String |
| custom_5 | A Custom Field for additional data. | False | String |
| custom_6 | A Custom Field for additional data. | False | String |
| custom_7 | A Custom Field for additional data. | False | String |
| custom_8 | A Custom Field for additional data. | False | String |
| custom_9 | A Custom Field for additional data. | False | String |
| custom_10 | A Custom Field for additional data. | False | String |
| custom_11 | A Custom Field for additional data. | False | String |
| custom_12 | A Custom Field for additional data. | False | String |
| custom_13 | A Custom Field for additional data. | False | String |
| custom_14 | A Custom Field for additional data. | False | String |
| custom_15 | A Custom Field for additional data. | False | String |
| custom_16 | A Custom Field for additional data. | False | String |
| custom_17 | A Custom Field for additional data. | False | String |
| custom_18 | A Custom Field for additional data. | False | String |
| custom_19 | A Custom Field for additional data. | False | String |
| custom_20 | A Custom Field for additional data. | False | String |