Status Update Webhook

The Carriyo webhook endpoint acts as the primary link for carriers to transmit real-time status updates to Carriyo.

The carrier's system will call the endpoint for each status update as and when they happen. It is important for the carrier to include the exact date and time of the event for Carriyo to uniquely identify each update.

This feature guarantees that Carriyo and its users consistently receive current and precise details regarding the shipment's progress and location.

Securityapi-key
Request
path Parameters
carrier
required
string
Request Body schema: application/json
required
tracking_number
required
string

Unique identifier assigned by the carrier to track the shipment.

status_update_date
required
string <date-time>

Date in ISO 8601 format. Example: 2020-09-03T17:07:05.000Z

carriyo_status_code
required
string

Internal Carriyo status code.

carriyo_reason_code
string

Internal Carriyo reason code.

carrier_status_code
string

Status code received from the carrier's tracking system

carrier_status_description
string

Description of the shipment status as provided by the carrier.

status_location
string

Description of the location associated with the latest shipment status update.

status_coordinates
string

GPS coordinates associated with the latest shipment status update.

proof_of_delivery_url
string

Direct URL to the Proof of Delivery (POD) document in PDF format.

proof_of_delivery_encoded
string

Proof of Delivery (POD) document content encoded in Base64 format.

driver_name
string

Name of the driver handling the delivery.

driver_phone
string

Contact phone number of the driver handling the delivery.

recipient_name
string

Full name of the shipment recipient.

Responses
200

OK

400

Error

post/{carrier}/update-status
Request samples
application/json
{
  • "tracking_number": "new-shipment-1",
  • "status_update_date": "2023-05-24T12:15:05.000Z",
  • "carriyo_status_code": "failed_delivery_attempt",
  • "carriyo_reason_code": "refused_by_customer",
  • "carrier_status_code": "CUSTOMER-REFUSAL",
  • "carrier_status_description": "Customer refused to accept delivery",
  • "status_location": "Dubai",
  • "status_coordinates": "25.18589831,55.2485668",
  • "proof_of_delivery_url": "https://example.com",
  • "proof_of_delivery_encoded": "",
  • "driver_name": "John",
  • "driver_phone": "string",
  • "recipient_name": "John"
}
Response samples
application/json
{
  • "request": {
    },
  • "tracking_info": {
    }
}