API docs by Redocly

Общение с покупателями (communication)

Управление вопросами и отзывами покупателей, шаблонами ответов, чатами, обработка возвратов

Общение с покупателями

Управление вопросами и отзывами покупателей, шаблонами ответов, чатами, обработка возвратов

Вопросы

Для доступа к методам используйте токен для категории Вопросы и отзывы

Непросмотренные отзывы и вопросы{{ /api/v1/new-feedbacks-questions }}

Описание метода

Возвращает информацию о наличии непросмотренных отзывов и вопросов у продавца

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Неотвеченные вопросы{{ /api/v1/questions/count-unanswered }}

Описание метода

Возвращает количество неотвеченных вопросов за сегодня и за всё время

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Количество вопросов{{ /api/v1/questions/count }}

Описание метода

Возвращает количество вопросов за заданный период

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
dateFrom
integer
Example: dateFrom=1688465092

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1688465092

Дата конца периода в формате Unix timestamp

isAnswered
boolean
Example: isAnswered=false

Обработанные вопросы (true) или необработанные вопросы (false).
Если не указать, вернутся обработанные вопросы.

Responses

Response samples

Content type
application/json
{
  • "data": 77,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Список вопросов{{ /api/v1/questions }}

Описание метода

Возвращает список вопросов по заданным параметрам с пагинацией и сортировкой

Можно получить максимум 10 000 вопросов в одном ответе
Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
isAnswered
required
boolean

Отвеченные вопросы (true) или неотвеченные вопросы(false)

nmId
integer

Артикул WB

take
required
integer

Количество запрашиваемых вопросов (максимально допустимое значение для параметра - 10 000, при этом сумма значений параметров take и skip не должна превышать 10 000)

skip
required
integer

Количество вопросов для пропуска (максимально допустимое значение для параметра - 10 000, при этом сумма значений параметров take и skip не должна превышать 10 000)

order
string

Сортировка вопросов по дате (dateAsc/dateDesc)

dateFrom
integer
Example: dateFrom=1688465092

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1688465092

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Работа с вопросами{{ /api/v1/questions }}

Описание метода

В зависимости от тела запроса позволяет:

  • Просмотреть вопрос
  • Отклонить вопрос
  • Ответить на вопрос или отредактировать ответ
Отредактировать ответ на вопрос можно 1 раз в течение 60 дней после отправки ответа
Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
Request Body schema: application/json
One of
id
required
string

Id вопроса

wasViewed
required
boolean

Просмотрен (true), не просмотрен (false)

Responses

Request samples

Content type
application/json
Example

Просмотреть вопрос

{
  • "id": "n5um6IUBQOOSTxXoo0gV",
  • "wasViewed": true
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Получить вопрос по ID{{ /api/v1/question }}

Описание метода

Возвращает вопрос по его ID

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
id
required
string
Example: id=ljAVapEBL38RyMdRln61

ID вопроса

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Получение вопросов в формате XLSX{{ /api/v1/questions/report }}

Описание метода

Возвращает файл с вопросами в формате XLSX в кодировке base64

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
isAnswered
required
boolean
Example: isAnswered=false

Обработанные вопросы (true) или необработанные вопросы(false)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Часто спрашиваемые товары{{ /api/v1/questions/products/rating }} Deprecated

Описание метода

Метод будет отключён 28 ноября.

Возвращает товары, про которые спрашивают чаще всего

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
size
required
integer
Example: size=1

Количество запрашиваемых товаров (max. 100)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Отзывы

Для доступа к методам используйте токен для категории Вопросы и отзывы

Необработанные отзывы{{ /api/v1/feedbacks/count-unanswered }}

Описание метода

Возвращает среднюю оценку всех отзывов и количество необработанных отзывов за сегодня и за всё время

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Количество отзывов{{ /api/v1/feedbacks/count }}

Описание метода

Возвращает количество отзывов

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
dateFrom
integer
Example: dateFrom=1688465092

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1688465092

Дата конца периода в формате Unix timestamp

isAnswered
boolean
Example: isAnswered=false

Обработанные отзывы(true) или необработанные отзывы(false).
Если не указать, вернутся обработанные отзывы.

Responses

Response samples

Content type
application/json
{
  • "data": 724583,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Список отзывов{{ /api/v1/feedbacks }}

Описание метода

Возвращает список отзывов по заданным параметрам с пагинацией и сортировкой

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
isAnswered
required
boolean
Example: isAnswered=false

Обработанные отзывы (true) или необработанные отзывы(false)

nmId
integer
Example: nmId=5870243

Артикул WB

take
required
integer
Example: take=1

Количество отзывов (max. 5 000)

skip
required
integer
Example: skip=0

Количество отзывов для пропуска (max. 199990)

order
string
Enum: "dateAsc" "dateDesc"

Сортировка отзывов по дате (dateAsc/dateDesc)

dateFrom
integer
Example: dateFrom=1688465092

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1688465092

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{}

Работа с отзывом{{ /api/v1/feedbacks }} Deprecated

Описание метода

Метод будет отключён 11 декабря.

В зависимости от тела запроса позволяет:

  • Просмотреть отзыв
  • Ответить на отзыв или отредактировать ответ
  • Оценить отзыв и/или товар

Отредактировать ответ на отзыв можно 1 раз в течение 2 месяцев (60 дней) после отправки ответа

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
Request Body schema: application/json
One of
id
required
string

Id отзыва

wasViewed
required
boolean

Просмотрен (true) или не просмотрен (false)

Responses

Request samples

Content type
application/json
Example

Просмотреть отзыв

{
  • "id": "n5um6IUBQOOSTxXoo0gV",
  • "wasViewed": true
}

Response samples

Content type
application/json
Example

Неправильный запрос

{
  • "data": null,
  • "error": true,
  • "errorText": "Something went wrong",
  • "additionalErrors": null,
  • "requestId": "734c9ea8-39e5-45c9-8cad-f03c13f733e9"
}

Получить списки причин жалоб на отзыв и проблем с товаром{{ /api/v1/supplier-valuations }}

Описание метода

Возвращает списки причин жалоб и проблем с товаром.

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
header Parameters
X-Locale
string
Example: ru

Выбор языка значений полей ответа (ru - русский, en - английский, zh - китайский)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Пожаловаться на отзыв, сообщить о проблеме с товаром{{ /api/v1/feedbacks/actions }}

Описание метода

Позволяет подать жалобу на отзыв и/или сообщить о проблеме с товаром из отзыва.
Валидация по ID отзыва отсутствует: если в запросе передано некорректное значение, вы не получите ошибку.

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string

ID отзыва

supplierFeedbackValuation
integer

Причина жалобы на отзыв
Можно получить из поля feedbackValuations, метод получения списков причин жалоб и проблем с товаром

supplierProductValuation
integer

Описание проблемы товара
Можно получить из поля productValuations, метод получения списков причин жалоб и проблем с товаром

Responses

Request samples

Content type
application/json
{
  • "id": "J2FMRjUj6hwvwCElqssz",
  • "supplierFeedbackValuation": 1,
  • "supplierProductValuation": 1
}

Ответить на отзыв{{ /api/v1/feedbacks/answer }}

Описание метода

Позволяет ответить на отзыв.
Валидация по ID отзыва отсутствует: если в запросе передано некорректное значение, вы не получите ошибку.


Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд

Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string

ID отзыва

text
required
string [ 2 .. 5000 ]

Текст ответа

Responses

Request samples

Content type
application/json
{
  • "id": "J2FMRjUj6hwvwCElqssz",
  • "text": "Спасибо за Ваш отзыв!"
}

Отредактировать ответ на отзыв{{ /api/v1/feedbacks/answer }}

Описание метода

Позволяет отредактировать уже отправленный ответ на отзыв.
Отредактировать ответ можно только один раз в течение 60 дней.
Валидация по ID отзыва отсутствует: если в запросе передано некорректное значение, вы не получите ошибку.

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string

ID отзыва

text
required
string [ 2 .. 5000 ]

Текст ответа

Responses

Request samples

Content type
application/json
{
  • "id": "J2FMRjUj6hwvwCElqssz",
  • "text": "Спасибо за Ваш отзыв, он очень важен для нас!"
}

Возврат товара по ID отзыва{{ /api/v1/feedbacks/order/return }}

Описание метода

Запрашивает на возврат товар, по которому оставлен отзыв.

Возврат доступен для отзывов с "isAbleReturnProductOrders": true

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
feedbackId
string

ID отзыва

Responses

Request samples

Content type
application/json
{
  • "feedbackId": "absdfgerrrfff1234"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "error": true,
  • "errorText": "string",
  • "additionalErrors": [
    ]
}

Получить отзыв по ID{{ /api/v1/feedback }}

Описание метода

Возвращает отзыв по его ID

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
id
required
string
Example: id=G7Y9Y1kBAtKOitoBT_lV

ID отзыва

Responses

Response samples

Content type
application/json
{}

Получение отзывов в формате XLSX{{ /api/v1/feedbacks/report }}

Описание метода

Возвращает файл с отзывами в формате XLSX в кодировке base64 Можно получить максимум 5000 отзывов в одном ответе

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
isAnswered
required
boolean
Enum: true false

Необработанный(false) или в архиве(true)

skip
integer
Example: skip=1

Параметр пагинации, указывает сколько отзывов пропустить (max. 20 000)

dateFrom
integer
Example: dateFrom=1696226971

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1698916171

Дата конца периода в формате Unix timestamp

order
string
Example: order=dateDesc

Сортировка отзывов по дате (dateAsc/dateDesc)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Список архивных отзывов{{ /api/v1/feedbacks/archive }}

Описание метода

Возвращает список архивных отзывов. Отзыв становится архивным, если:

  • На отзыв получен ответ
  • Ответ на отзыв не получен в течение 30 дней
  • В отзыве нет текста и фото
Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
nmId
integer
Example: nmId=14917842

Артикул WB

take
required
integer
Example: take=1

Количество отзывов (max. 5 000)

skip
required
integer
Example: skip=0

Количество отзывов для пропуска

order
string
Enum: "dateAsc" "dateDesc"

Сортировка отзывов по дате (dateAsc/dateDesc)

Responses

Response samples

Content type
application/json
{}

Средняя оценка товара по артикулу WB{{ /api/v1/feedbacks/products/rating/nmid }} Deprecated

Описание метода

Метод будет отключён 28 ноября.

Возвращает среднюю оценку товара по его артикулу WB

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
nmId
required
integer
Example: nmId=14917842

Артикул WB

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Родительские категории товаров{{ /api/v1/parent-subjects }} Deprecated

Описание метода

Метод будет отключён 28 ноября.

Возвращает список родительских категорий товаров продавца

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Товары с наибольшей и наименьшей средней оценкой по родительской категории{{ /api/v1/feedbacks/products/rating/top }} Deprecated

Описание метода

Метод будет отключён 28 ноября.

Возвращает список из двух товаров: с наибольшей и наименьшей средней оценкой по родительской категории

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
subjectId
required
integer
Example: subjectId=3109

id категории товара

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Средняя оценка товаров по родительской категории{{ /api/v1/feedbacks/products/rating }} Deprecated

Описание метода

Метод будет отключён 28 ноября.

Возвращает среднюю оценку товаров по родительской категории

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
subjectId
required
integer
Example: subjectId=3109

ID категории товара

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Шаблоны ответов

Для доступа к методам используйте токен для категории Вопросы и отзывы
Создание, получение, редактирование и удаление шаблонов ответов на вопросы и отзывы
Большинство ответов не дифференцируются по статус-коду.
На некорректный запрос вы получите ответ со статус-кодом 200 и описанием ошибки.

Получить шаблоны ответов для вопросов и отзывов{{ /api/v1/templates }}

Описание метода

Возвращает шаблоны ответов для вопросов и отзывов

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
query Parameters
templateType
required
integer
Example: templateType=1

1 - шаблоны для отзывов
2 - шаблоны для вопросов

Responses

Response samples

Content type
application/json
Example

Успешно

{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Создать шаблон{{ /api/v1/templates }}

Описание метода

Добавляет шаблон ответа на отзыв/вопрос. Можно создать максимум 20 шаблонов: 10 для отзывов и 10 для вопросов. Допустимы любые символы

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
Request Body schema: application/json
name
required
string

Название шаблона (от 1 до 100 символов)

templateType
required
integer

Тип шаблона
1 - шаблон для отзывов
2 - шаблон для вопросов

text
required
string

Текст шаблона (от 2 до 1000 символов)

Responses

Request samples

Content type
application/json
{
  • "name": "name",
  • "templateType": 1,
  • "text": "text"
}

Response samples

Content type
application/json
Example

Успешно

{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Редактировать шаблон{{ /api/v1/templates }}

Описание метода

Редактирует шаблон ответа на отзыв/вопрос. Допустимы любые символы

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
Request Body schema: application/json
name
required
string

Название шаблона (от 1 до 100 символов)

templateID
required
string

ID шаблона

text
required
string

Текст шаблона (от 2 до 1000 символов)

Responses

Request samples

Content type
application/json
{
  • "name": "newname",
  • "templateID": "1234fhbf34ew2",
  • "text": "newtext"
}

Response samples

Content type
application/json
Example

Успешно

{
  • "data": true,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Удалить шаблон{{ /api/v1/templates }}

Описание метода

Удаляет шаблон ответа на отзыв/вопрос

Максимум 1 запрос в секунду для всех методов категории Вопросы и отзывы на один аккаунт продавца.
Если превысить лимит в 3 запроса в секунду, отправка запросов будет заблокирована на 60 секунд
Authorizations:
HeaderApiKey
Request Body schema: application/json
templateID
required
string

ID шаблона (max. 1)

Responses

Request samples

Content type
application/json
{
  • "templateID": "1234fhbf34ew2"
}

Response samples

Content type
application/json
Example

Успешно

{
  • "data": true,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Чат с покупателями

Для доступа к методам используйте токен для категории Чат с покупателями
Чат позволяет продавцам и покупателям общаться напрямую.
Покупатели могут обращаться с вопросами по товарам или претензиями. Рекомендуем отвечать на сообщения в чате в течение 10 дней.
Чат всегда начинает покупатель. В одном чате можно общаться только с одним покупателем.
Обработка заявок на возврат товара доступна только в веб-версии чатов с покупателями.

Работа с чатами:

  1. Получите список чатов. Сохраните ID чатов в своей базе данных — это позволит обновлять информацию о чатах при получении событий.
  2. Получите события чатов: сообщения и возвраты. У новых чатов значение поля isNewChat будет true.
  3. Отправляйте сообщения в чат

Список чатов{{ /api/v1/seller/chats }}

Описание метода

Возвращает список всех чатов продавца.

Максимум 10 запросов за 10 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "errors": null
}

События чатов{{ /api/v1/seller/events }}

Описание метода

Возвращает список событий всех чатов. Чтобы получить все события:
1. Сделайте первый запрос без параметра next.
2. Повторяйте запрос со значением параметра next из ответа на предыдущий запрос, пока totalEvents не станет равным 0. Это будет означать, что вы получили все события.
Чтобы получать только новые события, укажите параметр next со значением поля addTimestamp из последнего полученного события.

Максимум 10 запросов за 10 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
next
integer

Пагинатор. С какого момента получить следующий пакет данных.
Формат Unix timestamp с миллисекундами

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "errors": null
}

Отправить сообщение{{ /api/v1/seller/message }}

Описание метода

Отправляет сообщения покупателю

Максимум 10 запросов за 10 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: multipart/form-data
required
replySign
required
string <= 255 characters

Подпись чата. Можно получить из информации по чату или данных события, если в событии есть поле "isNewChat": true.

message
string <= 1000 characters

Текст сообщения. Максимум 1000 символов.

file
Array of strings <binary> [ items <binary > ]

Файлы, формат JPEG, PDF или PNG, максимальный размер — 5 Мб каждый. Максимальный суммарный размер файлов — 30 Мб.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "errors": [ ]
}

Возвраты покупателями

Для доступа к методам используйте токен для категории Возвраты покупателями

Заявки покупателей на возврат{{ /api/v1/claims }}

Описание метода

Возвращает заявки покупателей на возврат товаров за текущие 14 дней

Максимум 20 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
is_archive
required
boolean
Example: is_archive=true

Состояние заявки:

  • false — на рассмотрении
  • true — в архиве
id
string <UUID>
Example: id=fe3e9337-e9f9-423c-8930-946a8ebef80

ID заявки

limit
integer <uint> [ 1 .. 200 ]
Example: limit=50

Количество заявок в ответе. По умолчанию 50

offset
integer <uint> >= 0
Example: offset=0

После какого элемента выдавать данные. По умолчанию 0

nm_id
integer
Example: nm_id=196320101

Артикул WB

Responses

Response samples

Content type
application/json
{
  • "claims": [
    ],
  • "total": 31
}

Ответ на заявку покупателя{{ /api/v1/claim }}

Описание метода

Отправляет ответ на заявку покупателя на возврат.

Максимум 20 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required

Ответ на заявку

id
string <UUID>

ID заявки

action
string

Действие с заявкой.
Используйте одно из значений массива actions — ответа метода получения заявок

comment
string [ 10 .. 1000 ] characters

Комментарий. Только при "action":"rejectcustom"

Responses

Request samples

Content type
application/json
{
  • "id": "fe3e9337-e9f9-423c-8930-946a8ebef80",
  • "action": "rejectcustom",
  • "comment": "Фото не имеет отношения к товару в заявке"
}

Response samples

Content type
application/json
{
  • "title": "Validation error",
  • "detail": "Input model is not valid; Details: The Action field is required.",
  • "requestId": "0HN3PI6JUGFSL:00000004"
}