Orders
We are no longer updating this site. For user documentation, please go to User Docs. For developer documentation, please go to Developer Docs. If you have any questions or feedback, please submit a ticket.
For more information about Orders in Zaius, please refer to our Orders reference:
post
https://api.zaius.com/v3
/events
Order Purchase
Example Payload
[
{
"type": "order",
"action": "purchase",
"identifiers": {
"email": "[email protected]"
},
"data": {
"ts": 123456789, // (optional) the time of the order purchase
"order": {
"order_id": "OR345",
"total": 109.65,
"discount": 5.00,
"subtotal": 103.00,
"tax": 5.15,
"shipping": 6.50,
"coupon_code": "5OFF",
"items": [
{
"product_id": "2045",
"price": 19.00,
"quantity": 5,
"discount": 0.00,
"subtotal": 95.00
},
{
"product_id": "2091",
"price": 10.00,
"quantity": 1,
"discount": 2.00,
"subtotal": 8.00
}
]
}
}
}
]
post
https://api.zaius.com/v3
/events
Order Return / Refund
Example Payload
[
{
"type": "order",
"action": "return", // or refund
"identifiers": {
"email": "[email protected]"
},
"data": {
"ts": 123456789, // (optional) the time of the order return | refund | cancel
"order": {
"order_id": "OR345",
//These values should be specified and the absolute amount specified will be subtracted from the existing value
"total": -100.00,
"subtotal": -90.00,
//If specified, these values overwrite any existing value and should be the positive remainder
"tax": 0,
"shipping": 0
"items": [
{
"product_id": "2045",
"price": -9.00,
"quantity": 10,
"subtotal": -90.00
}
]
}
}
}
]
post
https://api.zaius.com/v3
/events
Order Cancellation
Example Payload
[
{
"type": "order",
"action": "cancel",
"identifiers": {
"email": "[email protected]"
},
"data": {
"ts": 123456789, // (optional) the time of the order return | refund | cancel
"order": {
"order_id": "OR345",
"total": -100.00
"items": [
{
"product_id": "2045",
"price": -10.00,
"quantity": 10,
"subtotal": -100.00
}
]
}
}
}
]

Order Updates

To update the top-level order summary fields without generating events, use the Objects endpoint.
Copy link
On this page
post
Order Purchase
post
Order Return / Refund
post
Order Cancellation
Order Updates