Скачать файл заказа со стороны заказчика
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Скачайте готовый файл заказа, доступный заказчику. Возьмите id из записи файла и выберите src по списку, в котором он найден. При 200 OK сохраните тело ответа как файл.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
GET
https://partner-test-yamagistrali.ru/api/orders/file/forForwarder/v0
Тестовый стенд
Query parameters
|
Name |
Description |
|
id |
Type: string Example: `` |
|
orderId |
Type: string Example: `` |
|
src |
Type: string Источник файла. fs_order — заказ, fs_ct — шаблон условий Enum: |
Responses
200 OK
Содержимое файла
Body
/
Type: string
Format: binary
400 Bad Request
Bad Request
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
Error
|
Name |
Description |
|
info |
Type: object Example
|
|
message |
Type: string Example: |
|
message_code |
Type: string Example: |
Example
{
"info": {},
"message": "example",
"message_code": "example"
}
403 Forbidden
Forbidden
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
404 Not Found
Файл не найден
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|