Shipment Webhook Documentation

Overview

The Shipment Webhook is triggered whenever there is a status change in the shipment process. It sends real-time updates to an external webhook, ensuring seamless tracking and synchronization.

Tracked Statuses

The webhook is activated only for specific shipment statuses:

Status	Description
TO_PREPARE	The shipment is being prepared.
TO_WITHDRAW	The shipment is ready for pickup.
IN_TRANSIT	The shipment is currently in transit.
CARRIER_LATE	The carrier has reported a delay.
ARRIVED	The shipment has reached its final destination.
RETURNED	The shipment return has arrived at the warehouse.
PROCESSED	The shipment return is processed

Webhook Payload

Whenever a tracked status update occurs, the webhook sends the following payload:

{
    "shipmentId": number,
    "status": string,
    "omsOrderId": string,
    "trackingCode": string,
    "trackingLink": string,
    "isReturn": boolean 
}

Example Payload

{
    "shipmentId": 123456,
    "status": "IN_TRANSIT",
    "omsOrderId": "OMS78910",
    "trackingCode": "XYZ1234567",
    "trackingLink": "https://tracking.example.com/XYZ1234567",
    "isReturn": false
}

Webhook Endpoint Requirements

The external webhook must meet the following requirements:

• Accept HTTP POST requests.
• Support JSON payloads.
• Respond with a 200 OK status to acknowledge receipt of the webhook event.

Webhook Activation Process

To activate the Shipment Webhook for your system, you must provide your webhook URL to one of our developers. They will configure the necessary settings and ensure proper integration. Please reach out to our development team to get started.