Events
More information about webhooks at Webhooks.
Possible events
| Evento | Description |
|---|---|
| shipment.created | When an shipment is created |
| shipment.updated | When an shipment is updated |
| shipment.deleted | When an shipment id deleted |
| shipment.status_changed | When an shipment status is changed |
| shipment.tracking_event_appended | When a tracking event is appended |
| shipment.tracking_event_deleted | When a tracking event is deleted |
Request for shipment.[created, updated, deleted]
json
{
"event": "shipment.created",
"payload": {
"shipment_id": 1,
"shipment": {
"id": 3,
"order_number": "580950",
"tracking_code": "TR097329",
"tracking_code_label": "LBL269407",
"created_by_id": 1,
"updated_by_id": 3,
"created_at": "2023-06-28T20:57:23+00:00",
"updated_at": "2023-07-06T12:18:20+00:00",
"shipment_status": 1,
"shipment_status_text": "Draft"
}
},
"event_at": "2023-07-06T12:19:32+00:00"
}
Request for shipment.status_changed
json
{
"event": "shipment.tracking_event_appended",
"payload": {
"shipment_id": 4,
"tracking_id": 7,
"tracking_event_id": 79,
"shipment": {
"id": 4,
"order_number": "716142",
"tracking_code": "TR150262",
"tracking_code_label": "LBL913636",
"created_by_id": 1,
"updated_by_id": 3,
"created_at": "2023-06-28T20:57:23+00:00",
"updated_at": "2023-07-06T13:28:58+00:00",
"shipment_status": 10,
"shipment_status_text": "Confirmed"
},
"tracking_event": {
"id": 7,
"tracking_event_id": 79,
"code": "PCD",
"title_locale": {
"en-US": "Order confirmed.",
"pt-BR": "Pedido confirmado."
},
"short_description_locale": {
"pt-BR": "Pedido confirmado."
},
"note": null,
"country_id": null,
"state_id": null,
"event_at": "2023-07-06T13:28:58.000000Z",
"created_at": "2023-07-06T13:28:58.000000Z",
"created_by_id": 3,
"updated_at": "2023-07-06T13:28:58.000000Z",
"updated_by_id": null
}
},
"event_at": "2023-07-06T13:28:59+00:00"
}
Request for shipment.status_changed
json
{
"event": "shipment.tracking_event_deleted",
"payload": {
"shipment_id": 4,
"tracking_id": 7,
"tracking_event_id": 79,
"shipment": {
"id": 4,
"order_number": "716142",
"tracking_code": "TR150262",
"tracking_code_label": "LBL913636",
"created_by_id": 1,
"updated_by_id": 3,
"created_at": "2023-06-28T20:57:23+00:00",
"updated_at": "2023-07-06T13:28:58+00:00",
"shipment_status": 10,
"shipment_status_text": "Confirmed"
}
},
"event_at": "2023-07-06T13:28:59+00:00"
}