Get delivery history
The delivery’s ID must match the trip_id used on the delivery creation route.
Authentification
TIP
- api_key and partner_id in header
- api_key and partner in body
Routes
Routes | url |
---|---|
Tests | https://partners-api-preprod.shopopop.com/deliveries/{tripId}/history |
Prod | https://partners-api.shopopop.com/deliveries/{tripId}/history |
Method
Verb | GET |
---|
Path
Path | tripId: string |
---|
Headers
Header | type |
---|---|
api_key | string |
partner_id | string |
Will be given when testing phase is ready
Payload (return)
[
{
"status": "string",
"date": "string", // format YYYY-MM-DDTHH:mm:ssZ
"additional_info" : {
"delivery_man_id": "number",
"validation": "string" // (CODE / SIGNATURE) is_in_area: boolean,
"reason": "string"
}
},
...
]
Status are ordered from oldest to latest. Values in additional_info may vary regarding the status.
Response
HTTP STATUS 401/403
Access not authorized, the api_key and/or the partner_id are incorrect.
HTTP STATUS 404 (Delivery not found)
void
HTTP STATUS 500
{
"error": true,
"errorDesc: ["INTERNAL_ERROR"] // internal error, contact us.
}