API Change protocol - 20231110 - NextReservationTimes input parameter
What we want to change:
Add a new attribute nextReservationTimes into the request for POST /v2/reservation
Why we want to change:
To allow partners to supply additional possible reservation times for a TIME reservation in case the desired startReservationDate
(and expirationDate
) results in unsuccessfull reservation due to BOX_IS_FULL.
When we want to change:
Stage environment:
Plan:
During sprint No.2324, i.e. no later than No.2325
Actual:
21.11.2023
Production environment:
Plan:
During sprint No.2324, i.e. no later than No.2325
Actual:
22.11.2023
Affected enpoints
POST /v2/reservation
Example of change:
POST /parcel-lockers/v2/reservation
{
"data": {
"reservation": {
"id": "RES123",
"attributes": {
"startReservationDate": "2023-11-09T10:00:00.000Z",
"expirationDate": "2023-11-13T10:00:00.000Z",
"type": "TIME",
...
"nextReservationTimes": [
{
"startReservationDate": "2023-11-10T10:00:00.000Z",
//NOTE: Note the missing expiration date, since it is optional
//the root 'expirationDate' will be used, that is "2023-11-13T10:00:00.000Z"
},
{
"startReservationDate": "2023-11-11T10:00:00.000Z",
"expirationDate": "2023-11-13T10:00:00.000Z"
},
{
"startReservationDate": "2023-11-12T10:00:00.000Z",
"expirationDate": "2023-11-14T10:00:00.000Z"
}
]
}
}
}
}