Shift delivery
Allows to change delivery timeslot (date and hours)
Authentication
TIP
- api_key and partner_id in header
Routes
Routes | url |
---|---|
Tests | https://partners-api-preprod.shopopop.com/deliveries/{deliveryId}/delivery-slot |
Prod | https://partners-api.shopopop.com/deliveries/{deliveryId}/delivery-slot |
Method
Verb | PUT |
---|
Headers
Header | type |
---|---|
api_key | string |
partner_id | string |
Will be given when testing phase is ready
Path
Path | deliveryId : string | Partner's delivery id (tripId) |
---|
Payload
{
"delivery_start": "string",
"delivery_end": "string"
}
The format expected for delivery_start and delivery_end is ISO, with UTC timezone.
"2023-09-03T14:30Z"
"2023-09-03T08:00:00.000Z"
Response
HTTP STATUS 204
Delivery slot updated successfully
void
Common errors
HTTP STATUS 404
No delivery found with this partner Id.
{
"error": true,
"errorDesc: ["NOT_FOUND"]
}
HTTP STATUS 403
Access not authorized, the api_key and/or the partner_id are incorrect.
HTTP STATUS 409
The delivery exists but cannot be shifted according to its status.
{
"error": true,
"errorDesc: ["ERRAND_UPDATE_IMPOSSIBLE"]
}
HTTP STATUS 400
The delivery slot duration is too short.
{
"error": true,
"errorDesc: ["WRONG_INTERVAL_BETWEEN_DELIVERY_DATES"]
}
HTTP STATUS 400
The delivery slot start hour is too early.
{
"error": true,
"errorDesc: ["DELIVERY_DATE_TOO_CLOSE"]
}
HTTP STATUS 500
Internal error, contact us.
{
"error": true,
"errorDesc: ["INTERNAL_ERROR"]
}