By using the ‘WebhookUrl’ field or the subscriptions, you can specify a callback URL to get an update when the order is updated status. If the ‘WebhookUrl’ is set when creating an order or if a subscription exists, the API will send an HTTP POST request to that URL with a JSON payload containing the OrderId when the order status is changed. The kind of event that was triggered will be passed in a header called "Event-Type" where possible events are:
- scansession_checkpoint_completed
The following are examples of call-back content :
[CheckpointScanSessionCompleted]
Header: Event-Type: "scansession_checkpoint_completed"
Body:
{
"SessionId": "a3f8e1c2-4b5d-4a6e-9f70-1c2d3e4f5a6b",
"Timestamp": "2026-09-16T14:35:02.118+00:00",
"CheckpointId": "checkpoint-id",
"UserId": "3d8f1a2b-4c5e-6f70-8192-a3b4c5d6e7f8",
"FullyScannedItems": {
"CONTOSO123": ["b7a4e1c9-2d5f-4a80-9e13-7c6f3d8a90bb"]
},
"PartiallyScannedItems": {
"CONTOSO456": ["c8b5f2d0-3e6a-4b91-8f24-8d7e4f9b01cc"]
},
"DamagedItems": {},
"OverageItems": [
{
"Barcode": "1Z999AA10199999999",
"IsDamaged": false,
"ParcelId": null,
"Metadata": {}
}
],
"IncludedLicensePlates": [
{
"Id": "lp-9f8e7d6c",
"Barcode": "LP-0042"
}
],
"Metadata": {
"CONTOSO123": {
"b7a4e1c9-2d5f-4a80-9e13-7c6f3d8a90bb": {
"temperature": "frozen"
}
}
}
}