Получить комментарии к заказу со стороны заказчика
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Получите комментарии к заказу, доступные заказчику. Передайте data.orderId. Чтобы проверить запись, найдите в data.comments комментарий с сохранённым идентификатором.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/orders/comments/get/by/forwarder/v0
Тестовый стенд
Body
application/json
{
"data": {
"orderId": "example"
}
}
|
Name |
Description |
|
data |
Type: OrdersCommentsGetByForwarderV0Request Example |
OrdersCommentsGetByForwarderV0Request
|
Name |
Description |
|
orderId |
Type: string Example: |
Example
{
"orderId": "example"
}
Responses
200 OK
OK
Body
application/json
{
"data": {
"comments": [
{
"calledEmployees": [
"example"
],
"calledOrgs": [
"example"
],
"content": "example",
"createTs": {
"contact": null,
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"files": [
{}
],
"id": "example",
"ownerEmployeeContact": {},
"ownerEmployeeId": "example",
"ownerOrgId": "example",
"owners": [
{}
],
"updateTs": null,
"viewSelected": [
"example"
],
"viewers": [
{}
]
}
]
}
}
|
Name |
Description |
|
data |
Type: OrdersCommentsGetByForwarderV0Response Example |
TimestampTZOutputContact
|
Name |
Description |
|
name |
Type: string Example: |
|
orgId |
Type: string | null Example: |
|
orgName |
Type: string | null Example: |
|
orgTin |
Type: string | null Example: |
|
publicEmail |
Type: string | null Example: |
|
publicPhone |
Type: string | null Example: |
|
type |
Type: string Example: |
|
value |
Type: string Example: |
Example
{
"name": "example",
"orgId": "example",
"orgName": "example",
"orgTin": "example",
"publicEmail": "example",
"publicPhone": "example",
"type": "example",
"value": "example"
}
TimestampTZWContactOutput
|
Name |
Description |
|
contact |
Any of 2 types
Example |
|
displayTZ |
Type: string | null Example: |
|
time |
Type: string<date-time> | null Example: |
Example
{
"contact": {
"name": "example",
"orgId": "example",
"orgName": "example",
"orgTin": "example",
"publicEmail": "example",
"publicPhone": "example",
"type": "example",
"value": "example"
},
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
}
CommentFile
|
Name |
Description |
|
id |
Type: string Example: |
|
isEnabled |
Type: boolean |
|
name |
Type: string Example: |
Example
{
"id": "example",
"isEnabled": true,
"name": "example"
}
CommentOwner
|
Name |
Description |
|
ownerType |
Type: string Example: |
|
ids |
Type: string[] | null Example |
Example
{
"ids": [
"example"
],
"ownerType": "example"
}
CommentViewer
|
Name |
Description |
|
viewType |
Type: string Example: |
|
orgIds |
Type: string[] | null Example |
|
warehouseIds |
Type: string[] | null Example |
Example
{
"orgIds": [
"example"
],
"viewType": "example",
"warehouseIds": [
"example"
]
}
Comment
|
Name |
Description |
|
content |
Type: string Example: |
|
createTs |
Type: TimestampTZWContactOutput Example |
|
id |
Type: string Example: |
|
ownerOrgId |
Type: string Example: |
|
updateTs |
Type: TimestampTZWContactOutput Example |
|
calledEmployees |
Type: string[] | null Example |
|
calledOrgs |
Type: string[] | null Example |
|
files |
Type: CommentFile[] | null Example |
|
ownerEmployeeContact |
Any of 2 types
Example |
|
ownerEmployeeId |
Type: string | null Example: |
|
owners |
Type: CommentOwner[] | null Example |
|
viewers |
Type: CommentViewer[] | null Example |
|
viewSelected |
Type: string[] | null Example |
Example
{
"calledEmployees": [
"example"
],
"calledOrgs": [
"example"
],
"content": "example",
"createTs": {
"contact": {
"name": "example",
"orgId": "example",
"orgName": "example",
"orgTin": "example",
"publicEmail": "example",
"publicPhone": "example",
"type": "example",
"value": "example"
},
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"files": [
{
"id": "example",
"isEnabled": true,
"name": "example"
}
],
"id": "example",
"ownerEmployeeContact": null,
"ownerEmployeeId": "example",
"ownerOrgId": "example",
"owners": [
{
"ids": [
"example"
],
"ownerType": "example"
}
],
"updateTs": null,
"viewSelected": [
"example"
],
"viewers": [
{
"orgIds": [
"example"
],
"viewType": "example",
"warehouseIds": [
"example"
]
}
]
}
OrdersCommentsGetByForwarderV0Response
|
Name |
Description |
|
comments |
Type: Comment[] | null Example |
Example
{
"comments": [
{
"calledEmployees": [
"example"
],
"calledOrgs": [
"example"
],
"content": "example",
"createTs": {
"contact": {},
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"files": [
{
"id": "example",
"isEnabled": true,
"name": "example"
}
],
"id": "example",
"ownerEmployeeContact": null,
"ownerEmployeeId": "example",
"ownerOrgId": "example",
"owners": [
{
"ids": [
null
],
"ownerType": "example"
}
],
"updateTs": null,
"viewSelected": [
"example"
],
"viewers": [
{
"orgIds": [
null
],
"viewType": "example",
"warehouseIds": [
null
]
}
]
}
]
}
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 |
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |