Получение доступных чатов
Возвращает ваши чаты с покупателями.
| ⚙️ Лимит: 10000 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/chats
Path parameters
|
Name |
Type |
Description |
|
businessId* |
integer<int64> |
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. |
Query parameters
|
Name |
Type |
Description |
|
page_token |
string |
Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
|
limit |
integer<int32> |
Количество товаров на одной странице.
|
Body
{
"orderIds": [
0
],
"types": [
"CHAT"
],
"statuses": [
"NEW"
]
}
|
Name |
Type |
Description |
|
orderIds |
integer<int64>[] |
Фильтр по идентификаторам заказов на Маркете. |
|
types |
ChatType[] |
Фильтр по типам чатов.
|
|
statuses |
Фильтр по статусам чатов.
|
ChatType
Тип чата:
CHAT— чат с покупателем.ARBITRAGE— спор.
|
Type |
Description |
|
Enum: |
ChatStatusType
Статус чата:
NEW— новый чат.WAITING_FOR_CUSTOMER— нужен ответ покупателя;WAITING_FOR_PARTNER— нужен ответ магазина;WAITING_FOR_ARBITER— нужен ответ арбитра;WAITING_FOR_MARKET— нужен ответ Маркета;FINISHED— чат завершен.
|
Type |
Description |
|
Enum: |
Responses
200 OK
Список чатов.
Body
{
"status": "OK",
"result": {
"chats": [
{
"chatId": 0,
"orderId": 0,
"type": "CHAT",
"status": "NEW",
"createdAt": "2022-12-29T18:02:01Z",
"updatedAt": "2022-12-29T18:02:01Z"
}
],
"paging": {
"nextPageToken": "string"
}
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Список чатов. |
GetChatsInfoDTO
Список чатов.
|
Name |
Type |
Description |
|
chats* |
Информация о чатах. |
|
|
paging |
Информация о страницах с результатами. |
GetChatInfoDTO
Информация о чатах.
|
Name |
Type |
Description |
|
chatId* |
integer<int64> |
Идентификатор чата. |
|
orderId* |
integer<int64> |
Идентификатор заказа. |
|
type* |
Тип чата:
|
|
|
status* |
Статус чата:
|
|
|
createdAt* |
string<date-time> |
Дата и время создания чата. Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00. |
|
updatedAt* |
string<date-time> |
Дата и время последнего сообщения в чате. |
ForwardScrollingPagerDTO
Ссылка на следующую страницу.
|
Name |
Type |
Description |
|
nextPageToken |
string |
Идентификатор следующей страницы результатов. |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |