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
status_update_date
required
string <date-time>

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

carriyo_status_code
required
string
carriyo_reason_code
string
carrier_status_code
string
carrier_status_description
string
status_location
string
status_coordinates
string
proof_of_delivery
string
driver_name
string
driver_phone
string
recipient_name
string
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": null,
  • "proof_of_delivery": "",
  • "driver_name": "John",
  • "driver_phone": "",
  • "recipient_name": "John"
}
Response samples
application/json
{
  • "request": {
    },
  • "tracking_info": {
    }
}