Validation of the courier code
Validation of the code for receiving an order by courier
Request
POST
/platform/orders/{orderId}/codes/validate
Path parameters
|
Name |
Description |
|
orderId* |
Type: string The order ID in the external system |
Headers
|
Name |
Description |
|
Authorization |
Type: string A token generated on the side of the Yandex |
|
Partner-Name |
Type: string Partner name |
Body
application/json
{
"code": "string"
}
|
Name |
Description |
|
code* |
Type: string The code that needs to be validated |
Responses
200 OK
OK
Body
application/json
{
"is_valid": false
}
|
Name |
Description |
|
is_valid* |
Type: boolean Validation result. |
400 Bad Request
Request error
Body
application/json
{
"message": "string",
"code": 0
}
|
Name |
Description |
|
code* |
Type: integer Error code |
|
message* |
Type: string Erroe message |
403 Forbidden
Access denied
404 Not Found
The place was not found
Body
application/json
{
"message": "string",
"code": 0
}
|
Name |
Description |
|
code* |
Type: integer Error code |
|
message* |
Type: string Erroe message |
500 Internal Server Error
Internal server error
Body
application/json
{
"message": "string",
"code": 0
}
|
Name |
Description |
|
code* |
Type: integer Error code |
|
message* |
Type: string Erroe message |
No longer supported, please use an alternative and newer version.
Was the article helpful?
Previous