Получить файл комментария к заказу

Порядок работы для агента · Методы API и схема OpenAPI.

Назначение

Скачайте вложение к комментарию заказа со стороны исполнителя. Передайте data.orderId, data.commentId и идентификатор файла в data.commentFileId. При 200 OK сохраните тело ответа как файл.

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

Request

POST

https://partner-test-yamagistrali.ru/api/orders/comments/getFileByExecutor/v0

Тестовый стенд

Body

application/json
{
  "data": {
    "commentFileId": "example",
    "commentId": "example",
    "orderId": "example"
  }
}

Name

Description

data

Type: OrdersCommentsGetFileByExecutorV0Request

Example
{
  "commentFileId": "example",
  "commentId": "example",
  "orderId": "example"
}

OrdersCommentsGetFileByExecutorV0Request

Name

Description

commentFileId

Type: string

Example: example

commentId

Type: string

Example: example

orderId

Type: string

Example: example

Example
{
  "commentFileId": "example",
  "commentId": "example",
  "orderId": "example"
}

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
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

Error

Name

Description

info

Type: object

Example
{}

message

Type: string

Example: example

message_code

Type: string

Example: 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
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

404 Not Found

Файл не найден

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

500 Internal Server Error

Internal Server Error

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}