After you place an order, it's important to get updates on it from our platform.
We use webhooks to inform your software about updates on your order status.
This way, you can give your customers the most recent information about their orders.
To start getting webhooks, you can set up your callback URLs in the developer portal.
We always make sure our API is stable as it's essential for your business.
If we can't send you the webhook notification, we do an exponential backoff up to 10 times.
You can also poll the GET /api/v2/orders/{uuid} endpoint to get the latest status of the order request.
In the developer portal, you can subscribe to webhooks by adding a Webhook Url.
We will send POST requests to your Webhook Url when any of the following situations happen:
- order_created: order is created on the GoGoX platform
- order_matched: order is matched to a driver/courier partner
- order_released: order is, unfortunately, released by the matched driver
- amendment_added: order is completed and price amendments are added to the order
- order_completed: order is completed
- order_cancelled: order is cancelled
Sample POST request from GoGoX
{
"kinds":[
"order_created"
],
"reasons":[
"Order Available on Platform"
],
"created_at":"2023-04-30T08:08:59.000+00:00",
"data":{
"id": 1,
"nid":"CY4778995",
"uuid":"dddd0f12-9ebb-4186-b6b4-46bdee107d68",
"status":"pending",
"vehicle_type":"van",
"payment_method":"prepaid_wallet",
"courier":{
},
"pickup":{
"name":"Test",
"street_address":"address",
"floor_or_unit_number":null,
"schedule_at":1682827200,
"arrived_at":null,
"location":{
"lat":22.3122928,
"lng":114.1704655
},
"contact":{
"name":"Test",
"phone_number":"61234567",
"phone_extension":null
},
"epod_signature":{
"required":false,
"collected":false,
"images":{
"large":null,
"square_small":null
}
},
"epod_photo":{
"required":false,
"collected":false,
"images":{
"large":null,
"square_small":null
}
}
},
"destinations":[
{
"name":"Test",
"street_address":"Test Address",
"floor_or_unit_number":null,
"arrived_at":null,
"location":{
"lat":22.3213183,
"lng":114.1707561
},
"contact":{
"name":"Test",
"phone_number":"61234567"
},
"epod_signature":{
"required":false,
"collected":false,
"images":{
"large":null,
"square_small":null
}
},
"epod_photo":{
"required":false,
"collected":false,
"images":{
"large":null,
"square_small":null
}
}
}
],
"note_to_courier":"TEST",
"price":{
"amount":8500,
"currency":"HKD"
},
"price_breakdown":[
{
"key":"fee",
"amount":8000
}
]
}
}