Example payload
{
"object": "order",
"id": 41477,
"canceled": false,
"created_at": "2024-07-08T00:00:00Z",
"custom_variables": null,
"email": "[email protected]",
"first_name": "Onyx",
"language_code": 'en',
"last_name": "Graham",
"merchant_id": "ZMEN20579494985",
"mute_notifications": false,
"order_number": "ZMEN20579494985",
"ordered_at": "2024-07-08T00:00:00Z",
"phone": "848-189-6981",
"updated_at": "2024-07-17T15:39:59Z",
"uuid": "af50f332-f5b0-429b-b1ff-726ea3f050be",
"fulfillments": {
"object": "list",
"data": [
{
"object": "fulfillment",
"id": 42916
}
]
},
"line_items": {
"object": "list",
"data": [
{
"object": "line_item",
"id": 8793
}
]
},
"notifications": {
"object": "list",
"data": [
{
"object": "notification",
"id": 34768
}
]
},
"shipping_address": {
"object": "address",
"id": 83760
}
}
Attributes
| FIELD | DESCRIPTION |
|---|---|
| canceled boolean | Whether or not the order is canceled. |
| custom_variables object | Order custom variables |
| email string | Customer's email address |
| first_name string | Customer's first name |
| language_code string | Customer's language Defaults to your company's main language if not provided. See available values |
| 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. |
| 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. |
| created_at datetime | Time at which the order was imported into Shipup |
| updated_at datetime | Time at which the order was last updated |