API Docs
Home
Home
Developer GuideAPIStatusWebhooks
Developer GuideAPIStatusWebhooks
  1. Webhooks
  • WebHook connection required
  • HOOK EVENT ORDER CREATED
  • HOOK EVENT ORDER UPDATE STATUS
  • HOOK EVENT SHIPMENT CREATED
  • HOOK EVENT SHIPMENT UPDATE STATUS
  • HOOK EVENT INBOUND CREATED
  • HOOK EVENT INBOUND UPDATE STATUS
  • HOOK EVENT RETURN UPDATE STATUS
  • HOOK EVENT STOCK UPDATE
  1. Webhooks

HOOK EVENT SHIPMENT CREATED

This webhook is triggered when a shipment is successfully created in the system.

Trigger Conditions#

The webhook is sent when:
A new shipment is successfully created.
The system generates a tracking_code for the shipment.
The shipment is assigned to a carrier/courier service.

Payload Example#

Payload Fields#

FieldTypeDescription
event_codestringWebhook event code.
idintegerInternal shipment identifier.
tracking_codestringSystem tracking code of the shipment.
courier_tracking_codestringTracking code generated by the courier/carrier.
partner_tracking_codestringPartner reference/tracking code.
statusintegerCurrent shipment status code.
status_update_timeintegerUnix timestamp of the latest status update.
platformstringSource platform of the shipment.
store_idintegerAssociated store identifier.
created_timeintegerUnix timestamp when the shipment was created.
updated_timeintegerUnix timestamp when the shipment was last updated.
Previous
HOOK EVENT ORDER UPDATE STATUS
Next
HOOK EVENT SHIPMENT UPDATE STATUS
Built with