Добавить комментарий к заказу со стороны заказчика

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

Назначение

Добавьте комментарий к заказу со стороны заказчика. Передайте data.orderId, текст в data.content и согласованных получателей в data.viewers. Идентификатор комментария приходит в data.commentId.

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

Request

POST

https://partner-test-yamagistrali.ru/api/orders/comments/create/by/forwarder/v0

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

Body

application/json
{
  "data": {
    "content": "example",
    "fileContainerId": "example",
    "orderId": "example",
    "viewers": [
      "example"
    ]
  }
}

Name

Description

data

Type: OrdersCommentsCreateByForwarderV0Request

Example
{
  "content": "example",
  "fileContainerId": "example",
  "orderId": "example",
  "viewers": [
    "example"
  ]
}

OrdersCommentsCreateByForwarderV0Request

Name

Description

content

Type: string

Example: example

orderId

Type: string

Example: example

fileContainerId

Type: string | null

Example: example

viewers

Type: string[] | null

Example
[
  "example"
]
Example
{
  "content": "example",
  "fileContainerId": "example",
  "orderId": "example",
  "viewers": [
    "example"
  ]
}

Responses

200 OK

OK

Body

application/json
{
  "data": {
    "commentId": "example"
  }
}

Name

Description

data

Type: OrdersCommentsCreateByForwarderV0Response

Example
{
  "commentId": "example"
}

OrdersCommentsCreateByForwarderV0Response

Name

Description

commentId

Type: string

Example: example

Example
{
  "commentId": "example"
}

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"
}

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"
}