Skip to content
visitorId: Must match the ID passed to the widget under data-visitoridorderId: Must be provided by the store at checkoutbrandCode: Should match the widget’s data-brandcode value
Checkout Webhook Integration
Important Note
Staging Environment URL:
https://staging-saiz-app.com/api/checkout
Header Key: saiz-api-key
Header Value: 1fabc8404abd4f60b619b57a3d1790a8
Production Environment URL:
https://saiz-app.com/api/checkout
Header Key: saiz-api-key
Header Value: 1fabc8404abd4f60b619b57a3d1790a8
SAIZ Checkout Webhook Integration
Step 1: Authentication and Endpoint
Base URL: https://staging-saiz-app.com
Header Key: saiz-api-key
Header Value: 1fabc8404abd4f60b619b57a3d1790a8
This API key must be included in the request headers.
Step 2: Endpoint and Payload
HTTP Method: POST
Endpoint: https://staging-saiz-app.com/api/checkout/
JSON Body Format:
{
"orderId": "string",
"visitorId": "string",
"brandCode": "string"
}
Step 3: Expected Response
Successful calls return HTTP 204 No Content.
Code Example – Axios
axios.post('https://staging-saiz-app.com/api/checkout', {
orderId: 'order123',
visitorId: 'visitorXYZ',
brandCode: 'BRANDX'
}, {
headers: {
'Content-Type': 'application/json',
'saiz-api-key': '1fabc8404abd4f60b619b57a3d1790a8'
},
withCredentials: true
})
.then(() => {
// success handler
})
.catch((error) => {
// error handler
});
Code Example – cURL
curl --location 'https://saiz-app.com/api/checkout' \
--header 'Content-Type: application/json' \
--header 'saiz-api-key: 1fabc8404abd4f60b619b57a3d1790a8' \
--data '{
"orderId": "order123",
"visitorId": "visitorXYZ",
"brandCode": "BRANDX"
}'
Customization Notes
The webhook API can be extended with custom parameters or a different endpoint as needed. Customisation is supported per client requirements.
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ··· in the right corner or using a keyboard shortcut (
CtrlP
) instead.