Custom Third Party Delivery Documentation

this guide helps you integrate your third party delivery provider with our system using our custom third party delivery setup we support 🔐 step 1 setup & authentication to integrate with our system, you need to provide key description url base url of your third party delivery auth token token used for authentication you’ll set these values in the admin panel while configuring your third party delivery 📌 note the auth token is used as a bearer token in the authorization header during delivery creation 🧾 step 2 creating a delivery we’ll call your url with the following request ▶️ sample request we will send this payload to your system { "order id" "116305", "merchant id" "62b1c315f54672795f038de2", "order comment" null, "delivery instructions" null, "items" \[ { "name" "chair ar", "quantity" 1 } ], "pickup" { "pickup timestamp" "2025 07 22 16 41 54", "name" "buck's cafe", "contact" "+19056364601", "location" { "type" "point", "coordinates" \[ 79 5370341, 43 8287327 ] }, "address" { "full address" "3175 rutherford rd", "country code" "ca" }, "payment" { "amount" 377, "currency code" "usd" } }, "drop" { "drop timestamp" "2025 07 22 17 26 54", "name" "farhan", "contact" "+919651861130", "location" { "type" "point", "coordinates" \[ 80 9796823, 26 8828811 ] }, "address" { "full address" "12, indira nagar main rd, sector 23, liberty colony park, sarvodaya nagar, indira nagar, lucknow, uttar pradesh 226022, india", "building" "58", "area" null, "landmark" null, "city" "lucknow", "country code" "in" }, "payment" { "amount" 377, "currency code" "usd" } }, "agent tip earning" null, "is pickup proof required" false, "is delivery proof required" false, "scheduled at" null } 🔐 headers authorization bearer your auth token content type application/json your system should return the following expected response ✅ expected response { "delivery id" "xyz", "delivery status" "pending", "tracking url" "https //yourthirdpartydelivery com/track/xyz" } 🔔 step 3 sending webhooks (required) once the delivery status updated (picked, completed, cancelled), your system must notify us via webhook 📬 webhook url your unique webhook url is auto generated and visible in the admin panel it looks like https //delivery apps hyperzod dev/api/v1/1003/webhook/order/customdelivery 📦 webhook payload send a post request to the webhook url with the following structure { "delivery id" "xyz", "delivery status" "completed", // completed / cancelled / picked } 📘 delivery status values value description completed delivery has been completed cancelled delivery has been cancelled picked delivery has been picked ✅ make sure your webhook server handles retries in case of temporary failure