API changes summary
Description | In production | In stage | Link to documentation | Link to change protocol |
|---|---|---|---|---|
OpenerKey attribute in reservations eendpoints | TBD | TBD |
| https://alzabox.atlassian.net/wiki/spaces/ABD/pages/227311617 |
NextReservationTimes input parameter | 22.11.2023 | 21.11.2023 | https://alzabox.atlassian.net/wiki/spaces/ABD/pages/147456001 | https://alzabox.atlassian.net/wiki/spaces/ABD/pages/147259393 |
Products input parameter | 22.11.2023 | 21.11.2023 |
|
|
Patching package(s) dimensions | 26.9.2023 | 22.9.2023 |
|
|
Patching reservation time window | 26.9.2023 | 22.9.2023 |
|
|
Add support for message code and two use cases |
| 31.8.2023 |
|
|
Add info about usage of the type of slots |
|
|
|
|
Add an ability to filter reservations by package’s barcode | 6.7.2023 | 3.7.2023 |
|
|
Patch endpoint for updating box PID | 27.03.2023 | 23.03.2023 |
|
|
Ability to block reservation directly during create or update process | 15.3.2023 | 12.3.2023 |
|
|
Ability to control full access to couriers using the fullbox access attribute | 19.1.2023 | 12.1.2023 |
|
|
Make clear that deliveryPin is always dynamic | 21.06.2022 | 01.5.2022 |
|
|
CountryShortCode in GET BOX response | 16.06.2022 | 01.6.2022 |
|
|
Shipping list and carrier | 08.06.2022 |
|
|
|
Partner's delivery PIN - documentation for dynamic partner PIN | 05.04.2022 |
|
|
|
Callbacks - new documentation section about callbacks, which we provide for partners reservation status changes | 30.03.2022 |
|
|
|
Box occupancy - new box information about general occupancy in % | 09.03.2022 |
|
|
|
Required fields - minor changes in docs | 23.02.2022 |
|
|
|
Reservation type - possibility of defining reservation type added to post reservation endpoint | 10.02.2022 |
|
|
|
Status changes clarification - minor changes in docs, beter explanation of changing status | 13.12.2021 |
|
|
|
New error message - minor changes in error messages | 08.12.2021 |
|
|
|
Payment data - information about payment data added to get reservation endpoint | 11.11.2021 |
|
|
|
Box slots - information about slots types added to get boxes endpoint | 20.09.2021 |
|
|
|
Carriers' passwords - information about carrier PIN added to get reservation endpoint | 25.08.2021 |
|
|
|
New connector - new API version via dedicated connector | 06.08.2021 |
|
|
|
Updated version - minor updates | 28.02.2021 |
|
|
|
Initial version - first version of documentation | 26.05.2020 |
|
|
|
Documentation process of API changes
We have produced a new OpenAPI API specification in JSON format and have published it to our GitHub repository. So, you can track the differences in the repository by “watching” it.
If the API change involves a new function, we create a new documentation page in our Confluence knowledge base. If it modifies an existing function, we update the relevant documentation page.
We create a new Confluence page build on “API change protocol” template and store it in the designated folder.
We add a new row to the table above, including a description of the changes, the release date in both the production and testing environments, a link to the documentation, and a link to the change protocol page.
