Example order object
{
"object": "order",
"id": 18279002,
"canceled": false,
"custom_variables": {},
"email": "[email protected]",
"first_name": "Alice",
"language_code": "fr",
"last_name": "Dubois",
"merchant_id": "C100000954413",
"mute_notifications": false,
"order_number": "C100000954413",
"ordered_at": 1564610400,
"phone": null,
"shipping_address": null,
"uuid": "d7431d29-db7b-4bdd-aaef-5574c0d0109a",
"created_at": 1564683016,
"updated_at": 1564683016,
"fulfillments": null,
"line_items": null,
"notifications": null,
"shipping_address": null
}
An order is a customer's completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process.
| FIELD | DESCRIPTION |
|---|---|
| id integer | Unique identifier for the order |
| canceled boolean | Whether or not the order is canceled. Defaults to false |
| custom_variables object | Order custom variables |
| email string | Customer's email address |
| first_name string | Customer's first name |
| language_code string see available values | Customer's language Defaults to your company's main language if not provided |
| last_name string | Customer's last name |
| merchant_id string | Unique identifier used by the online retailer for the order |
| mute_notifications boolean | If set to true, no notification will be generated for this order. Defaults to false |
| order_number string | Shop order reference |
| ordered_at datetime | Time at which the order was placed. Mandatory to send pre-shipment notifications |
| phone string | Customer's mobile phone. The phone format should either: - follow the international format (eg. with +33 or 0033)- use the local (national) format. If so, Shipup adds the international prefix thanks to the shipping address' country. |
| uuid string | Unique identifier for the object, UUID format. |
| fulfillments list of fulfillments, expandable | List of fulfillments for this order |
| line_items list of line items, expandable | List of items constituting the order |
| notifications list of notifications, expandable | List of notifications sent for this order |
| shipping_address address, expandable | Shipping address for this order |
| created_at datetime | Time at which the order was imported into Shipup |
| updated_at datetime | Time at which the order was last updated |