Trip Status

API Details for 'Order Status'

Configure Webhook

POST /webhooks/subscribe

Use this api to subscribe to the real time order status updates.

Headers

Name	Type	Description
API_KEY*	string	API key obtained for the customer/partner

200 Webhook created

{
    "status": "PASS",
    "message": "Webhook configured successfully"
}

400 Bad request/Validation error

{
   "status": "FAIL",
   "message": "Webhook update failed"
}

Example Value | Schema

{
  "webhookId": 13,
  "callbackUrl": "https://myserver.com/send/callback/here",
  "headers": {
      "API_KEY": "bSd74acDFhjzy90vqml"
  },
  "verify_payload": true
}

Event	Topics
trip_created	Trip Creation Updates: { "Client": "ParkDairy Services Ltd", "StatusDateTime": "2022-11-14T06:08:11.222230", "eventType": "trip_created", "tripId": "TRIP-27UVORZ", "trip_planned_date": "2022-11-17" }

Update Webhook configuration

PUT /webhooks/update

Use this api to update an existing webhook like callback url, active etc.

Headers

Name	Type	Description
API_KEY	String	API key obtained by the customer/partner

200 Webhook config updated

{
   "status": "PASS",
   "message": "Updated the webhook successfully"
}

400 Bad Request/Validation Error

{
   "status": string,
   "message": string
}

Example | Schema

{
    "webhookId": 12,
    "callbackUrl": "https://myserver.com/send/callback/here",
    "headers": {
        "API_KEY": "bSd74acDFhjzy90vqml"
    },
    "is_active": false
}

Postman Collection

We have a Postman collection to make the integration quicker and easier. You can test all our APIs by importing the full API collection through the 'Run in Postman' button and running them in the Postman app.