- Request
- Responses
- 200 OK
- Body
- ApiResponseStatusType
- PagedReturnsDTO
- ForwardScrollingPagerDTO
- ReturnDTO
- LogisticPickupPointDTO
- RecipientType
- ReturnShipmentStatusType
- ReturnItemDTO
- PickupAddressDTO
- LogisticPointType
- ReturnDecisionDTO
- ReturnInstanceDTO
- TrackDTO
- ReturnDecisionReasonType
- ReturnDecisionSubreasonType
- ReturnDecisionType
- ReturnInstanceStockType
- ReturnInstanceStatusType
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 500 Internal Server Error
Список возвратов и невыкупов
Получает список возвратов и невыкупов.
Чтобы получить информацию по одному возврату или невыкупу, выполните запрос GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}.
⚙️ Лимит: 10 000 запросов в час |
---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/returns
Path parameters
Name |
Type |
Description |
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
Query parameters
Name |
Type |
Description |
page_token |
string |
Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
limit |
integer<int32> |
Количество товаров на одной странице.
|
orderIds |
integer<int64>[] |
Идентификаторы заказов — для фильтрации результатов. Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50. |
statuses |
Статусы возвратов или невыкупов — для фильтрации результатов. Несколько статусов перечисляются через запятую.
|
|
type |
Тип заказа для фильтрации:
Если не указывать, в ответе будут и возвраты, и невыкупы. |
|
fromDate |
string<date> |
Начальная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: |
toDate |
string<date> |
Конечная дата для фильтрации возвратов или невыкупов по дате обновления. Формат: |
from_date |
string<date> |
Этот параметр устарел. Вместо него используйте Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
|
to_date |
string<date> |
Этот параметр устарел. Вместо него используйте Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
|
RefundStatusType
Cтатус возврата денег:
-
STARTED_BY_USER
— создан клиентом из личного кабинета. -
REFUND_IN_PROGRESS
— ждет решение о возврате денег. -
REFUNDED
— по возврату проведены все возвратные денежные транзакции. -
FAILED
— невозможно провести возврат покупателю. -
WAITING_FOR_DECISION
— ожидает решения. -
DECISION_MADE
— по возврату принято решение. -
REFUNDED_WITH_BONUSES
— возврат осуществлен баллами Плюса или промокодом. -
REFUNDED_BY_SHOP
— магазин сделал самостоятельно возврат денег. -
CANCELLED
— возврат отменен.
Type |
Description |
Enum: |
ReturnType
Тип заказа для фильтрации:
-
RETURN
— возврат. -
UNREDEEMED
— невыкуп.
Если не указывать, в ответе будут и возвраты, и невыкупы.
Type |
Description |
Enum: |
Responses
200 OK
Постраничные возвраты партнера.
Body
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string"
},
"returns": [
{
"id": 0,
"orderId": 0,
"creationDate": "2022-12-29T18:02:01Z",
"updateDate": "2022-12-29T18:02:01Z",
"refundStatus": "STARTED_BY_USER",
"logisticPickupPoint": {
"id": 0,
"name": "string",
"address": {
"country": "Россия",
"city": "Москва",
"street": "Стрелецкая улица",
"house": "9к2",
"postcode": 123518
},
"instruction": "string",
"type": "WAREHOUSE",
"logisticPartnerId": 0
},
"shipmentRecipientType": "SHOP",
"shipmentStatus": "CREATED",
"refundAmount": 0,
"items": [
{
"marketSku": 0,
"shopSku": "string",
"count": 0,
"decisions": [
{
"returnItemId": 0,
"count": 0,
"comment": "string",
"reasonType": "BAD_QUALITY",
"subreasonType": "USER_DID_NOT_LIKE",
"decisionType": "REFUND_MONEY",
"refundAmount": 0,
"partnerCompensation": 0,
"images": [
"string"
]
}
],
"instances": [
{
"stockType": "FIT",
"status": "CREATED",
"cis": "string",
"imei": "string"
}
],
"tracks": [
{
"trackCode": "string"
}
]
}
],
"returnType": "UNREDEEMED"
}
]
}
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
result |
Возвраты. |
PagedReturnsDTO
Возвраты.
Name |
Type |
Description |
paging |
Информация о страницах с результатами. |
|
returns |
Список возвратов. |
ForwardScrollingPagerDTO
Ссылка на следующую страницу.
Name |
Type |
Description |
nextPageToken |
string |
Идентификатор следующей страницы результатов. |
ReturnDTO
Возврат заказа.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор возврата. |
orderId |
integer<int64> |
Номер заказа. |
creationDate |
string<date-time> |
Дата создания возврата клиентом. |
updateDate |
string<date-time> |
Дата обновления возврата. |
refundStatus |
Cтатус возврата денег:
|
|
logisticPickupPoint |
Пункт вывоза. |
|
shipmentRecipientType |
Способ возврата товара покупателем.
|
|
shipmentStatus |
Статус передачи возврата.
|
|
refundAmount |
integer<int64> |
Сумма возврата. |
items |
Список товаров в возврате. |
|
returnType |
Тип возврата.
|
LogisticPickupPointDTO
Описание пункта вывоза для возврата.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор пункта вывоза. |
name |
string |
Название пункта вывоза. |
address |
Адрес пункта вывоза. |
|
instruction |
string |
Дополнительные инструкции к вывозу. |
type |
Тип логистической точки.
|
|
logisticPartnerId |
integer<int64> |
Идентификатор логистического партнера, к которому относится логистическая точка. |
RecipientType
Способ возврата товара покупателем:
-
SHOP
— в точку возврата магазина. -
DELIVERY_SERVICE
— отправить курьером. -
POST
— почта.
Type |
Description |
Enum: |
ReturnShipmentStatusType
Статус передачи возврата:
-
CREATED
— возврат создан. -
RECEIVED
— принят у покупателя. -
IN_TRANSIT
— возврат в пути. -
READY_FOR_PICKUP
— возврат готов к выдаче магазину. -
PICKED
— возврат выдан магазину. -
LOST
— возврат утерян при транспортировке. -
CANCELLED
— возврат отменен. -
FULFILMENT_RECEIVED
— возврат принят на складе Маркета. -
PREPARED_FOR_UTILIZATION
— возврат передан в утилизацию. -
UTILIZED
— возврат утилизирован.
Type |
Description |
Enum: |
ReturnItemDTO
Список товаров в возврате.
Name |
Type |
Description |
marketSku |
integer<int64> |
SKU товара на Маркете. |
shopSku* |
string |
Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы Правила использования SKU:
Что такое SKU и как его назначать
|
count* |
integer<int64> |
Количество единиц товара. |
decisions |
Список решений по возврату. |
|
instances |
Список логистических позиций возврата. |
|
tracks |
TrackDTO[] |
Список трек-кодов для почтовых отправлений. |
PickupAddressDTO
Адрес доставки.
Name |
Type |
Description |
country |
string |
Страна.
|
city |
string |
Город.
|
street |
string |
Улица.
|
house |
string |
Номер дома.
|
postcode |
string |
Почтовый индекс.
|
LogisticPointType
Тип логистической точки:
WAREHOUSE
— склад.PICKUP_POINT
— обычная точка выдачи заказов (ПВЗ).PICKUP_TERMINAL
— постамат.PICKUP_POST_OFFICE
— отделение почтовой связи (ОПС).PICKUP_MIXED
— торговый зал и пункт выдачи заказов.PICKUP_RETAIL
— торговый зал.
Type |
Description |
Enum: |
ReturnDecisionDTO
Решения по возвратам.
Name |
Type |
Description |
returnItemId |
integer<int64> |
Идентификатор товара в возврате. |
count |
integer<int32> |
Количество единиц товара. |
comment |
string |
Комментарий. |
reasonType |
Причины возврата:
|
|
subreasonType |
Детали причин возврата:
|
|
decisionType |
Решение по возврату:
|
|
refundAmount |
integer<int64> |
Сумма возврата. |
partnerCompensation |
integer<int64> |
Компенсация за обратную доставку. |
images |
string[] |
Список хеш-кодов фотографий товара от покупателя. |
ReturnInstanceDTO
Логистическая информация по возврату.
Name |
Type |
Description |
stockType |
Тип остатка на складе.
|
|
status |
Логистический статус конкретного товара.
|
|
cis |
string |
Код идентификации единицы товара в системе «Честный ЗНАК». |
imei |
string |
Международный идентификатор мобильного оборудования. |
TrackDTO
Информация о трек-номерах.
Name |
Type |
Description |
trackCode |
string |
Трек-код почтового отправления. |
ReturnDecisionReasonType
Причины возврата:
-
BAD_QUALITY
— бракованный товар (есть недостатки). -
DO_NOT_FIT
— товар не подошел. -
WRONG_ITEM
— привезли не тот товар. -
DAMAGE_DELIVERY
— товар поврежден при доставке. -
LOYALTY_FAIL
— невозможно установить виновного в браке/пересорте. -
CONTENT_FAIL
— ошибочное описание товара по вине Маркета. -
UNKNOWN
— причина не известна.
Type |
Description |
Enum: |
ReturnDecisionSubreasonType
Детали причин возврата:
-
DO_NOT_FIT
:USER_DID_NOT_LIKE
— товар не понравился.USER_CHANGED_MIND
— передумал покупать.DELIVERED_TOO_LONG
— длительный срок доставки, поэтому передумал.
-
BAD_QUALITY
:BAD_PACKAGE
— упаковка товара была нарушена.DAMAGED
— царапины, сколы.NOT_WORKING
— не включается / не работает.INCOMPLETENESS
— некомплект (не хватает детали в наборе, к товару).
-
WRONG_ITEM
:WRONG_ITEM
— не тот товар.WRONG_COLOR
— не соответствует по цвету.DID_NOT_MATCH_DESCRIPTION
— не соответствует заявленным характеристикам/описанию.
Type |
Description |
Enum: |
ReturnDecisionType
Решение по возврату:
-
REFUND_MONEY
— вернуть деньги покупателю. -
REFUND_MONEY_INCLUDING_SHIPMENT
— вернуть деньги за товар и пересылку. -
REPAIR
— отремонтировать товар. -
REPLACE
— заменить товар. -
SEND_TO_EXAMINATION
— взять товар на экспертизу. -
DECLINE_REFUND
— отказать в возврате. -
OTHER_DECISION
— другое решение.
Type |
Description |
Enum: |
ReturnInstanceStockType
Тип остатка на складе.
Type |
Description |
Enum: |
ReturnInstanceStatusType
Логистический статус конкретного товара.
Type |
Description |
Enum: |
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 |
Список ошибок. |