Список невыкупов и возвратов

Получает список невыкупов и возвратов.

Чтобы получить информацию по одному возврату или невыкупу, выполните запрос GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}.

⚙️ Лимит: 10 000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/returns

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

fromDate

Type: string<date>

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.
Example: 2022-10-31

from_date

⦸

Type: string<date>

Этот параметр устарел. Вместо него используйте fromDate.

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
Example: 2022-10-31

limit

Type: integer<int32>

Количество значений на одной странице.
Example: 20

orderIds

Type: integer<int64>[]

Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела.

Example: 123543

Max items: 50

Unique items: true

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

statuses

Type: RefundStatusType[]

Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.
Example: STARTED_BY_USER,WAITING_FOR_DECISION

toDate

Type: string<date>

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.
Example: 2022-11-30

to_date

⦸

Type: string<date>

Этот параметр устарел. Вместо него используйте toDate.

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
Example: 2022-11-30

type

Type: ReturnType

Тип заказа для фильтрации:

  • RETURN — возврат.

  • UNREDEEMED — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

RefundStatusType

Cтатус возврата денег:

  • STARTED_BY_USER — создан клиентом из личного кабинета.

  • REFUND_IN_PROGRESS — ждет решение о возврате денег.

  • REFUNDED — по возврату проведены все возвратные денежные транзакции.

  • FAILED — невозможно провести возврат покупателю.

  • WAITING_FOR_DECISION — ожидает решения.

  • DECISION_MADE — по возврату принято решение.

  • REFUNDED_WITH_BONUSES — возврат осуществлен баллами Плюса или промокодом.

  • REFUNDED_BY_SHOP — магазин сделал самостоятельно возврат денег.

  • COMPLETE_WITHOUT_REFUND — возврат денег не требуется.

  • CANCELLED — возврат отменен.

Type

Description

RefundStatusType

Enum: STARTED_BY_USER, REFUND_IN_PROGRESS, REFUNDED, FAILED, WAITING_FOR_DECISION, DECISION_MADE, REFUNDED_WITH_BONUSES, REFUNDED_BY_SHOP, CANCELLED, COMPLETE_WITHOUT_REFUND, UNKNOWN

ReturnType

Тип заказа для фильтрации:

  • RETURN — возврат.

  • UNREDEEMED — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

Type

Description

ReturnType

Enum: UNREDEEMED, RETURN

Responses

200 OK

Постраничные возвраты партнера.

Body

application/json
{
    "status": "OK",
    "result": {
        "paging": {
            "nextPageToken": "string"
        },
        "returns": [
            {
                "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,
                "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",
                "fastReturn": false
            }
        ]
    }
}

Name

Description

result

Type: PagedReturnsDTO

Возвраты.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

PagedReturnsDTO

Возвраты.

Name

Description

returns*

Type: ReturnDTO[]

Список возвратов.
Возврат заказа.

Параметров logisticPickupPoint, shipmentRecipientType и shipmentStatus может не быть в случае возврата:

  • С опцией Быстрый возврат денег за дешевый брак, когда товар остается у покупателя (fastReturn=true).
  • По заказу для бизнеса, если:
    • статус возврата STARTED_BY_USER или WAITING_FOR_DECISION;
    • возврат отменен до передачи товара.

paging

Type: ForwardScrollingPagerDTO

Информация о страницах с результатами.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

ReturnDTO

Возврат заказа.

Параметров logisticPickupPoint, shipmentRecipientType и shipmentStatus может не быть в случае возврата:

  • С опцией Быстрый возврат денег за дешевый брак, когда товар остается у покупателя (fastReturn=true).
  • По заказу для бизнеса, если:
    • статус возврата STARTED_BY_USER или WAITING_FOR_DECISION;
    • возврат отменен до передачи товара.

Name

Description

id*

Type: integer<int64>

Идентификатор возврата.

items*

Type: ReturnItemDTO[]

Список товаров в возврате.
Список товаров в возврате.

orderId*

Type: integer<int64>

Номер заказа.

returnType*

Type: ReturnType

Тип возврата.

Enum: UNREDEEMED, RETURN

creationDate

Type: string<date-time>

Дата создания возврата клиентом.

Формат даты: ISO 8601 со смещением относительно UTC.

Example: 2020-02-02T14:30:30+03:00

fastReturn

Type: boolean

Используется ли опция Быстрый возврат денег за дешевый брак.

logisticPickupPoint

Type: LogisticPickupPointDTO

Пункт вывоза.

refundAmount

Type: integer<int64>

Сумма возврата.

refundStatus

Type: RefundStatusType

Cтатус возврата денег:

  • STARTED_BY_USER — создан клиентом из личного кабинета.

  • REFUND_IN_PROGRESS — ждет решение о возврате денег.

  • REFUNDED — по возврату проведены все возвратные денежные транзакции.

  • FAILED — невозможно провести возврат покупателю.

  • WAITING_FOR_DECISION — ожидает решения.

  • DECISION_MADE — по возврату принято решение.

  • REFUNDED_WITH_BONUSES — возврат осуществлен баллами Плюса или промокодом.

  • REFUNDED_BY_SHOP — магазин сделал самостоятельно возврат денег.

  • COMPLETE_WITHOUT_REFUND — возврат денег не требуется.

  • CANCELLED — возврат отменен.

Enum: STARTED_BY_USER, REFUND_IN_PROGRESS, REFUNDED, FAILED, WAITING_FOR_DECISION, DECISION_MADE, REFUNDED_WITH_BONUSES, REFUNDED_BY_SHOP, CANCELLED, COMPLETE_WITHOUT_REFUND, UNKNOWN

shipmentRecipientType

Type: RecipientType

Способ возврата товара покупателем.

Enum: SHOP, DELIVERY_SERVICE, POST

shipmentStatus

Type: ReturnShipmentStatusType

Статус передачи возврата.

Enum: 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

updateDate

Type: string<date-time>

Дата обновления возврата.

Формат даты: ISO 8601 со смещением относительно UTC.

Example: 2020-02-02T14:30:30+03:00

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

ReturnItemDTO

Список товаров в возврате.

Name

Description

count*

Type: integer<int64>

Количество единиц товара.

shopSku*

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

decisions

Type: ReturnDecisionDTO[]

Список решений по возврату.
Решения по возвратам.

instances

Type: ReturnInstanceDTO[]

Список логистических позиций возврата.
Логистическая информация по возврату.

marketSku

Type: integer<int64>

SKU товара на Маркете.

Min value: 1

tracks

Type: TrackDTO[]

Список трек-кодов для почтовых отправлений.
Информация о трек-номерах.

LogisticPickupPointDTO

Описание пункта вывоза для возврата.

Name

Description

address

Type: PickupAddressDTO

Адрес пункта вывоза.

id

Type: integer<int64>

Идентификатор пункта вывоза.

instruction

Type: string

Дополнительные инструкции к вывозу.

logisticPartnerId

Type: integer<int64>

Идентификатор логистического партнера, к которому относится логистическая точка.

name

Type: string

Название пункта вывоза.

type

Type: LogisticPointType

Тип логистической точки.

Enum: WAREHOUSE, PICKUP_POINT, PICKUP_TERMINAL, PICKUP_POST_OFFICE, PICKUP_MIXED, PICKUP_RETAIL, UNKNOWN

RecipientType

Способ возврата товара покупателем:

  • SHOP — в точку возврата магазина.

  • DELIVERY_SERVICE — отправить курьером.

  • POST — почта.

Type

Description

RecipientType

Enum: SHOP, DELIVERY_SERVICE, POST

ReturnShipmentStatusType

Статус передачи возврата:

  • CREATED — возврат создан.

  • RECEIVED — принят у покупателя.

  • IN_TRANSIT — возврат в пути.

  • READY_FOR_PICKUP — возврат готов к выдаче магазину.

  • PICKED — возврат выдан магазину.

  • LOST — возврат утерян при транспортировке.

  • CANCELLED — возврат отменен.

  • FULFILMENT_RECEIVED — возврат принят на складе Маркета.

  • PREPARED_FOR_UTILIZATION — возврат передан в утилизацию.

  • UTILIZED — возврат утилизирован.

Type

Description

ReturnShipmentStatusType

Enum: 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

ReturnDecisionDTO

Решения по возвратам.

Name

Description

comment

Type: string

Комментарий.

count

Type: integer<int32>

Количество единиц товара.

decisionType

Type: ReturnDecisionType

Решение по возврату:

  • REFUND_MONEY — вернуть деньги покупателю.

  • REFUND_MONEY_INCLUDING_SHIPMENT — вернуть деньги за товар и пересылку.

  • REPAIR — отремонтировать товар.

  • REPLACE — заменить товар.

  • SEND_TO_EXAMINATION — взять товар на экспертизу.

  • DECLINE_REFUND — отказать в возврате.

  • OTHER_DECISION — другое решение.

Enum: REFUND_MONEY, REFUND_MONEY_INCLUDING_SHIPMENT, REPAIR, REPLACE, SEND_TO_EXAMINATION, DECLINE_REFUND, OTHER_DECISION, UNKNOWN

images

Type: string[]

Список хеш-кодов фотографий товара от покупателя.

partnerCompensation

Type: integer<int64>

Компенсация за обратную доставку.

reasonType

Type: ReturnDecisionReasonType

Причины возврата:

  • BAD_QUALITY — бракованный товар (есть недостатки).

  • DO_NOT_FIT — товар не подошел.

  • WRONG_ITEM — привезли не тот товар.

  • DAMAGE_DELIVERY — товар поврежден при доставке.

  • LOYALTY_FAIL — невозможно установить виновного в браке/пересорте.

  • CONTENT_FAIL — ошибочное описание товара по вине Маркета.

  • DELIVERY_FAIL — товар не привезли.

  • UNKNOWN — причина не известна.

Enum: BAD_QUALITY, DOES_NOT_FIT, WRONG_ITEM, DAMAGE_DELIVERY, LOYALTY_FAIL, CONTENT_FAIL, DELIVERY_FAIL, UNKNOWN

refundAmount

Type: integer<int64>

Сумма возврата.

returnItemId

Type: integer<int64>

Идентификатор товара в возврате.

subreasonType

Type: ReturnDecisionSubreasonType

Детали причин возврата:

  • DO_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 — заказ не привезли полностью.

Enum: USER_DID_NOT_LIKE, USER_CHANGED_MIND, DELIVERED_TOO_LONG, BAD_PACKAGE, DAMAGED, NOT_WORKING, INCOMPLETENESS, WRONG_ITEM, WRONG_COLOR, DID_NOT_MATCH_DESCRIPTION, WRONG_ORDER, WRONG_AMOUNT_DELIVERED, WRAPPING_DAMAGED, ITEM_WAS_USED, BROKEN, BAD_FLOWERS, PARCEL_MISSING, INCOMPLETE, UNKNOWN

ReturnInstanceDTO

Логистическая информация по возврату.

Name

Description

cis

Type: string

Код идентификации единицы товара в системе «Честный ЗНАК».

imei

Type: string

Международный идентификатор мобильного оборудования.

status

Type: ReturnInstanceStatusType

Логистический статус конкретного товара.

Enum: CREATED, RECEIVED, IN_TRANSIT, READY_FOR_PICKUP, PICKED, RECEIVED_ON_FULFILLMENT, CANCELLED, LOST, UTILIZED, PREPARED_FOR_UTILIZATION, EXPROPRIATED, NOT_IN_DEMAND

stockType

Type: ReturnInstanceStockType

Тип остатка на складе.

Enum: FIT, DEFECT, ANOMALY, SURPLUS, EXPIRED, MISGRADING, UNDEFINED, INCORRECT_IMEI, INCORRECT_SERIAL_NUMBER, INCORRECT_CIS, PART_MISSING, NON_COMPLIENT, NOT_ACCEPTABLE, SERVICE, MARKDOWN, DEMO, REPAIR, FIRMWARE, UNKNOWN

TrackDTO

Информация о трек-номерах.

Name

Description

trackCode

Type: string

Трек-код почтового отправления.

PickupAddressDTO

Адрес доставки.

Name

Description

city

Type: string

Город.

Example: Москва

country

Type: string

Страна.

Example: Россия

house

Type: string

Номер дома.

Example: 9к2

postcode

Type: string

Почтовый индекс.

Example: 123518

street

Type: string

Улица.

Example: Стрелецкая улица

LogisticPointType

Тип логистической точки:

  • WAREHOUSE — склад.
  • PICKUP_POINT — обычная точка выдачи заказов (ПВЗ).
  • PICKUP_TERMINAL — постамат.
  • PICKUP_POST_OFFICE — отделение почтовой связи (ОПС).
  • PICKUP_MIXED — торговый зал и пункт выдачи заказов.
  • PICKUP_RETAIL — торговый зал.

Type

Description

LogisticPointType

Enum: WAREHOUSE, PICKUP_POINT, PICKUP_TERMINAL, PICKUP_POST_OFFICE, PICKUP_MIXED, PICKUP_RETAIL, UNKNOWN

ReturnDecisionType

Решение по возврату:

  • REFUND_MONEY — вернуть деньги покупателю.

  • REFUND_MONEY_INCLUDING_SHIPMENT — вернуть деньги за товар и пересылку.

  • REPAIR — отремонтировать товар.

  • REPLACE — заменить товар.

  • SEND_TO_EXAMINATION — взять товар на экспертизу.

  • DECLINE_REFUND — отказать в возврате.

  • OTHER_DECISION — другое решение.

Type

Description

ReturnDecisionType

Enum: REFUND_MONEY, REFUND_MONEY_INCLUDING_SHIPMENT, REPAIR, REPLACE, SEND_TO_EXAMINATION, DECLINE_REFUND, OTHER_DECISION, UNKNOWN

ReturnDecisionReasonType

Причины возврата:

  • BAD_QUALITY — бракованный товар (есть недостатки).

  • DO_NOT_FIT — товар не подошел.

  • WRONG_ITEM — привезли не тот товар.

  • DAMAGE_DELIVERY — товар поврежден при доставке.

  • LOYALTY_FAIL — невозможно установить виновного в браке/пересорте.

  • CONTENT_FAIL — ошибочное описание товара по вине Маркета.

  • DELIVERY_FAIL — товар не привезли.

  • UNKNOWN — причина не известна.

Type

Description

ReturnDecisionReasonType

Enum: BAD_QUALITY, DOES_NOT_FIT, WRONG_ITEM, DAMAGE_DELIVERY, LOYALTY_FAIL, CONTENT_FAIL, DELIVERY_FAIL, UNKNOWN

ReturnDecisionSubreasonType

Детали причин возврата:

  • DO_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 — заказ не привезли полностью.

Type

Description

ReturnDecisionSubreasonType

Enum: USER_DID_NOT_LIKE, USER_CHANGED_MIND, DELIVERED_TOO_LONG, BAD_PACKAGE, DAMAGED, NOT_WORKING, INCOMPLETENESS, WRONG_ITEM, WRONG_COLOR, DID_NOT_MATCH_DESCRIPTION, WRONG_ORDER, WRONG_AMOUNT_DELIVERED, WRAPPING_DAMAGED, ITEM_WAS_USED, BROKEN, BAD_FLOWERS, PARCEL_MISSING, INCOMPLETE, UNKNOWN

ReturnInstanceStatusType

Логистический статус конкретного товара.

Type

Description

ReturnInstanceStatusType

Enum: CREATED, RECEIVED, IN_TRANSIT, READY_FOR_PICKUP, PICKED, RECEIVED_ON_FULFILLMENT, CANCELLED, LOST, UTILIZED, PREPARED_FOR_UTILIZATION, EXPROPRIATED, NOT_IN_DEMAND

ReturnInstanceStockType

Тип остатка на складе:

  • FIT — годный.

  • DEFECT — бракованный.

  • ANOMALY — аномалия.

  • SURPLUS — лишний.

  • EXPIRED — просроченный.

  • MISGRADING — пересортица.

  • UNDEFINED — с неизвестным статусом.

  • INCORRECT_IMEI — товар с некорректным IMEI.

  • INCORRECT_SERIAL_NUMBER — товар с некорректным серийным номером.

  • INCORRECT_CIS — товар с некорректным кодом идентификации единицы товара в системе «Честный ЗНАК».

  • PART_MISSING — недостача.

  • NON_COMPLIENT — товар с множественными несоответствиями.

  • NOT_ACCEPTABLE — товар, который Маркет не принимает.

  • SERVICE — сервисный сток.

  • MARKDOWN — уценка.

  • DEMO — демо.

  • REPAIR — ремонт.

  • FIRMWARE — прошивка.

  • UNKNOWNS — неизвестный тип товара.

Type

Description

ReturnInstanceStockType

Enum: FIT, DEFECT, ANOMALY, SURPLUS, EXPIRED, MISGRADING, UNDEFINED, INCORRECT_IMEI, INCORRECT_SERIAL_NUMBER, INCORRECT_CIS, PART_MISSING, NON_COMPLIENT, NOT_ACCEPTABLE, SERVICE, MARKDOWN, DEMO, REPAIR, FIRMWARE, UNKNOWN

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

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: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR
Предыдущая
Удаление
Следующая
Информация о невыкупе или возврате