API Change Protocol - 20230822 - Response error codes
What we want to change:
We would like to add new attribute to error responses to help AB partners diagnose what happend if response is not ok.
Why we want to change:
The previous method e.g. did not allow AB partner to determine whether the problem was in the request itself, or whether the issue was that the box was occupied, or that the package was too large.
When we want to change:
Stage environment:
Production environemnt:
Affected enpoints
All v1 and v2 endpoints (in case of negative - error - response)
Example of change:
Response:
{
"data": null,
"metadata": null,
"errors": [
{
"message": "string",
+ "messageCode": "BOX_IS_FULL",
"locations": null,
"path": null,
"extensions": {
"code": "string",
"translation": null
}
}
]
} First new messageCodes:
BOX_IS_FULL: in case when is not possible to make a reservation into required box because box is full
BOX_IS_NOT_BIG_ENOUGH: in case when is not possible to make a reservation into required box because box is not big enough for required package
null: in other cases