- Request
- Responses
- 200 OK
- Body
- ReturnDTO
- ApiResponseStatusType
- ReturnItemDTO
- ReturnType
- CurrencyValueDTO
- LogisticPickupPointDTO
- RefundStatusType
- RecipientType
- ReturnShipmentStatusType
- ReturnDecisionDTO
- ReturnInstanceDTO
- TrackDTO
- CurrencyType
- PickupAddressDTO
- LogisticPointType
- ReturnDecisionType
- ReturnDecisionReasonType
- ReturnDecisionSubreasonType
- ReturnInstanceStatusType
- ReturnInstanceStockType
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 500 Internal Server Error
Информация о невыкупе или возврате
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- inventory-and-order-processing — Обработка заказов и учёт товаров
- inventory-and-order-processing:read-only — Просмотр информации о заказах
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всей информации в кабинете
Получает информацию по одному невыкупу или возврату.
Подключите API-уведомления
Маркет отправит вам запрос POST notification, когда появится новый невыкуп или возврат.
⚙️ Лимит: 10 000 запросов в час |
---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
orderId* |
Type: integer<int64> Идентификатор заказа. |
returnId* |
Type: integer<int64> Идентификатор возврата. |
Responses
200 OK
Детали возврата.
Body
application/json
{
"status": "OK",
"result": {
"id": 0,
"orderId": 0,
"creationDate": "2020-02-02T14:30:30+03:00",
"updateDate": "2020-02-02T14:30:30+03:00",
"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,
"amount": {
"value": 0,
"currencyId": "RUR"
},
"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,
"amount": {
"value": 0,
"currencyId": "RUR"
},
"partnerCompensation": 0,
"partnerCompensationAmount": {
"value": 0,
"currencyId": "RUR"
},
"images": [
"string"
]
}
],
"instances": [
{
"stockType": "FIT",
"status": "CREATED",
"cis": "string",
"imei": "string"
}
],
"tracks": [
{
"trackCode": "string"
}
]
}
],
"returnType": "UNREDEEMED",
"fastReturn": false
}
}
Name |
Description |
result |
Type: ReturnDTO Возврат заказа. Параметров
Статус возврата денег |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
ReturnDTO
Возврат заказа.
Параметров logisticPickupPoint
, shipmentRecipientType
и shipmentStatus
может не быть в случае возврата:
- С опцией Быстрый возврат денег за дешевый брак, когда товар остается у покупателя (
fastReturn=true
). - По заказу от бизнеса, если:
- статус возврата
STARTED_BY_USER
илиWAITING_FOR_DECISION
; - возврат отменен до передачи товара.
- статус возврата
Статус возврата денег refundStatus
актуален только для returnType=RETURN
.
Name |
Description |
id* |
Type: integer<int64> Идентификатор возврата. |
items* |
Type: ReturnItemDTO[] Список товаров в возврате. |
orderId* |
Type: integer<int64> Номер заказа. |
returnType* |
Type: ReturnType Тип заказа для фильтрации:
Если не указать, в ответе будут и невыкупы, и возвраты. Enum: |
amount |
Type: CurrencyValueDTO Сумма возврата. |
creationDate |
Type: string<date-time> Дата создания возврата клиентом. Формат даты: ISO 8601 со смещением относительно UTC. Example: |
fastReturn |
Type: boolean Используется ли опция Быстрый возврат денег за дешевый брак. Актуально только для |
logisticPickupPoint |
Type: LogisticPickupPointDTO Пункт вывоза. |
refundAmount ⦸
|
Type: integer<int64> Этот параметр устарел Вместо него используйте Сумма возврата в копейках. |
refundStatus |
Type: RefundStatusType Статус возврата денег:
Enum: |
shipmentRecipientType |
Type: RecipientType Способ возврата товара покупателем. Enum: |
shipmentStatus |
Type: ReturnShipmentStatusType Статус передачи возврата. Enum: |
updateDate |
Type: string<date-time> Дата обновления возврата. Формат даты: ISO 8601 со смещением относительно UTC. Example: |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
ReturnItemDTO
Список товаров в возврате.
Name |
Description |
count* |
Type: integer<int64> Количество единиц товара. |
shopSku* |
Type: string Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: Max length: Pattern: |
decisions |
Type: ReturnDecisionDTO[] Список решений по возврату. |
instances |
Type: ReturnInstanceDTO[] Список логистических позиций возврата. |
marketSku |
Type: integer<int64> SKU товара на Маркете. Min value: |
tracks |
Type: TrackDTO[] Список трек-кодов для почтовых отправлений. |
ReturnType
Тип заказа для фильтрации:
-
UNREDEEMED
— невыкуп. -
RETURN
— возврат.
Если не указать, в ответе будут и невыкупы, и возвраты.
Type |
Description |
Enum: |
CurrencyValueDTO
Значение с валютой.
Name |
Description |
currencyId* |
Type: CurrencyType Валюта. Enum: |
value* |
Type: number Значение. |
LogisticPickupPointDTO
Описание пункта вывоза для возврата.
Name |
Description |
address |
Type: PickupAddressDTO Адрес пункта вывоза. |
id |
Type: integer<int64> Идентификатор пункта вывоза. |
instruction |
Type: string Дополнительные инструкции к вывозу. |
logisticPartnerId |
Type: integer<int64> Идентификатор логистического партнера, к которому относится логистическая точка. |
name |
Type: string Название пункта вывоза. |
type |
Type: LogisticPointType Тип логистической точки. Enum: |
RefundStatusType
Статус возврата денег:
-
STARTED_BY_USER
— создан клиентом из личного кабинета. -
REFUND_IN_PROGRESS
— ждет решение о возврате денег. -
REFUNDED
— по возврату проведены все возвратные денежные транзакции. -
FAILED
— невозможно провести возврат покупателю. -
WAITING_FOR_DECISION
— ожидает решения. -
DECISION_MADE
— по возврату принято решение. -
REFUNDED_WITH_BONUSES
— возврат осуществлен баллами Плюса или промокодом. -
REFUNDED_BY_SHOP
— магазин сделал самостоятельно возврат денег. -
COMPLETE_WITHOUT_REFUND
— возврат денег не требуется. -
CANCELLED
— возврат отменен. -
UNKNOWN
— неизвестный статус.
Type |
Description |
Enum: |
RecipientType
Способ возврата товара покупателем:
-
SHOP
— в точку возврата магазина. -
DELIVERY_SERVICE
— отправить курьером. -
POST
— почта.
Type |
Description |
Enum: |
ReturnShipmentStatusType
Статус передачи возврата:
-
CREATED
— возврат создан. -
RECEIVED
— принят у покупателя. -
IN_TRANSIT
— возврат в пути. -
READY_FOR_PICKUP
— возврат готов к выдаче магазину. -
PICKED
— возврат выдан магазину. -
LOST
— возврат утерян при транспортировке. -
EXPIRED
— покупатель не принес товар на возврат вовремя. -
CANCELLED
— возврат отменен. -
FULFILMENT_RECEIVED
— возврат принят на складе Маркета. -
PREPARED_FOR_UTILIZATION
— возврат передан в утилизацию. -
NOT_IN_DEMAND
— возврат не забрали с почты. -
UTILIZED
— возврат утилизирован. -
READY_FOR_EXPROPRIATION
— товары в возврате направлены на перепродажу. -
RECEIVED_FOR_EXPROPRIATION
— товары в возврате приняты для перепродажи. -
UNKNOWN
— неизвестный статус.
Type |
Description |
Enum: |
ReturnDecisionDTO
Решения по возвратам.
Name |
Description |
amount |
Type: CurrencyValueDTO Сумма возврата. |
comment |
Type: string Комментарий. |
count |
Type: integer<int32> Количество единиц товара. |
decisionType |
Type: ReturnDecisionType Решение по возврату:
Enum: |
images |
Type: string[] Список хеш-кодов фотографий товара от покупателя. |
partnerCompensation ⦸
|
Type: integer<int64> Этот параметр устарел Вместо него используйте Компенсация за обратную доставку в копейках. |
partnerCompensationAmount |
Type: CurrencyValueDTO Компенсация за обратную доставку. |
reasonType |
Type: ReturnDecisionReasonType Причины возврата:
Enum: |
refundAmount ⦸
|
Type: integer<int64> Этот параметр устарел Вместо него используйте Сумма возврата в копейках. |
returnItemId |
Type: integer<int64> Идентификатор товара в возврате. |
subreasonType |
Type: ReturnDecisionSubreasonType Детали причин возврата:
Enum: |
ReturnInstanceDTO
Логистическая информация по возврату.
Name |
Description |
cis |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). |
imei |
Type: string Международный идентификатор мобильного оборудования. |
status |
Type: ReturnInstanceStatusType Логистический статус конкретного товара. Enum: |
stockType |
Type: ReturnInstanceStockType Тип остатка на складе. Enum: |
TrackDTO
Информация о трек-номерах.
Name |
Description |
trackCode |
Type: string Трек-код почтового отправления. |
CurrencyType
Коды валют. Возможные значения:
RUR
— российский рубль.UAH
— украинская гривна.BYR
— белорусский рубль.KZT
— казахстанский тенге.UZS
— узбекский сум.
Type |
Description |
Enum: |
PickupAddressDTO
Адрес доставки.
Name |
Description |
city |
Type: string Город. Example: |
country |
Type: string Страна. Example: |
house |
Type: string Номер дома. Example: |
postcode |
Type: string Почтовый индекс. Example: |
street |
Type: string Улица. Example: |
LogisticPointType
Тип логистической точки:
WAREHOUSE
— склад.PICKUP_POINT
— обычная точка выдачи заказов (ПВЗ).PICKUP_TERMINAL
— постамат.PICKUP_POST_OFFICE
— отделение почтовой связи (ОПС).PICKUP_MIXED
— торговый зал и пункт выдачи заказов.PICKUP_RETAIL
— торговый зал.
Type |
Description |
Enum: |
ReturnDecisionType
Решение по возврату:
-
REFUND_MONEY
— вернуть деньги покупателю. -
REFUND_MONEY_INCLUDING_SHIPMENT
— вернуть деньги за товар и пересылку. -
REPAIR
— отремонтировать товар. -
REPLACE
— заменить товар. -
SEND_TO_EXAMINATION
— взять товар на экспертизу. -
DECLINE_REFUND
— отказать в возврате. -
OTHER_DECISION
— другое решение. -
UNKNOWN
— не указано.
Type |
Description |
Enum: |
ReturnDecisionReasonType
Причины возврата:
-
BAD_QUALITY
— бракованный товар (есть недостатки). -
DOES_NOT_FIT
— товар не подошел. -
WRONG_ITEM
— привезли не тот товар. -
DAMAGE_DELIVERY
— товар поврежден при доставке. -
LOYALTY_FAIL
— невозможно установить виновного в браке/пересорте. -
CONTENT_FAIL
— ошибочное описание товара по вине Маркета. -
DELIVERY_FAIL
— товар не привезли. -
UNKNOWN
— причина не известна.
Type |
Description |
Enum: |
ReturnDecisionSubreasonType
Детали причин возврата:
-
DOES_NOT_FIT
:USER_DID_NOT_LIKE
— товар не понравился.USER_CHANGED_MIND
— передумал покупать.DELIVERED_TOO_LONG
— передумал покупать из-за длительного срока доставки.
-
BAD_QUALITY
:BAD_PACKAGE
— заводская упаковка повреждена.DAMAGED
— царапины, сколы.NOT_WORKING
— не включается, не работает.INCOMPLETENESS
— некомплект (не хватает детали в наборе, к товару).WRAPPING_DAMAGED
— транспортная упаковка повреждена.ITEM_WAS_USED
— следы использования на товаре.BROKEN
— товар разбит.BAD_FLOWERS
— некачественные цветы.
-
WRONG_ITEM
:WRONG_ITEM
— не тот товар.WRONG_COLOR
— цвет не соответствует заявленному.DID_NOT_MATCH_DESCRIPTION
— описание или характеристики не соответствуют заявленным.WRONG_ORDER
— доставили чужой заказ.WRONG_AMOUNT_DELIVERED
— неверное количество товара.PARCEL_MISSING
— часть заказа отсутствует.INCOMPLETE
— заказ не привезли полностью.
-
UNKNOWN
— детали причины не указаны.
Type |
Description |
Enum: |
ReturnInstanceStatusType
Логистический статус конкретного товара:
-
CREATED
— возврат создан. -
RECEIVED
— возврат принят у отправителя. -
IN_TRANSIT
— возврат в пути. -
READY_FOR_PICKUP
— возврат готов к выдаче магазину. -
PICKED
— возврат выдан магазину. -
RECEIVED_ON_FULFILLMENT
— возврат принят на складе Маркета. -
CANCELLED
— возврат отменен. -
LOST
— возврат утерян. -
UTILIZED
— возврат утилизирован. -
PREPARED_FOR_UTILIZATION
— возврат готов к утилизации. -
EXPROPRIATED
— товары в возврате направлены на перепродажу. -
NOT_IN_DEMAND
— возврат не забрали с почты.
Type |
Description |
Enum: |
ReturnInstanceStockType
Тип остатка на складе:
-
FIT
— годный. -
DEFECT
— бракованный. -
ANOMALY
— аномалия. -
SURPLUS
— лишний. -
EXPIRED
— просроченный. -
MISGRADING
— пересортица. -
UNDEFINED
— с неизвестным статусом. -
INCORRECT_IMEI
— товар с некорректным IMEI. -
INCORRECT_SERIAL_NUMBER
— товар с некорректным серийным номером. -
INCORRECT_CIS
— товар с некорректным кодом идентификации единицы товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). -
PART_MISSING
— недостача. -
NON_COMPLIENT
— товар с множественными несоответствиями. -
NOT_ACCEPTABLE
— товар, который Маркет не принимает. -
SERVICE
— сервисный сток. -
MARKDOWN
— уценка. -
DEMO
— демо. -
REPAIR
— ремонт. -
FIRMWARE
— прошивка. -
UNKNOWN
— неизвестный тип товара.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
ApiErrorDTO
Общий формат ошибки.
Name |
Description |
code* |
Type: string Код ошибки. |
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.