Статусы проверки УИНов

Метод доступен для моделей: FBS и Экспресс.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает статусы проверки УИНов в заказе.

Заказ, в котором есть ювелирные изделия, перейдет в статус READY_TO_SHIP, только когда:

  1. Вы передадите Маркету УИНы по каждому ювелирному изделию в заказе — метод PUT campaigns/{campaignId}/orders/{orderId}/boxes.
  2. Все УИНы успешно пройдут проверку.
⚙️ Лимит: 100 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/identifiers/status

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании.

Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:

  • Модули и API → блок Передача данных Маркету.
  • Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Min value: 1

orderId*

Type: integer<int64>

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

Responses

200 OK

Информация по проверке УИНов.

Body

application/json
{
    "status": "OK",
    "result": {
        "items": [
            {
                "id": 0,
                "uin": [
                    {
                        "value": "string",
                        "status": "OK"
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: GetOrderIdentifiersStatusDTO

Список идентификаторов товаров и статусы проверки УИНов.

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

GetOrderIdentifiersStatusDTO

Список идентификаторов товаров и статусы проверки УИНов.

Name

Description

items*

Type: OrderItemValidationStatusDTO[]

Список идентификаторов товаров и статусы проверки УИНов.
Идентификатор товара и статус проверки его УИНа.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OrderItemValidationStatusDTO

Идентификатор товара и статус проверки его УИНа.

Name

Description

id*

Type: integer<int64>

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

uin

Type: UinDTO[]

Статусы проверки УИНов.
Статус проверки УИНа.

Min items: 1

UinDTO

Статус проверки УИНа.

Name

Description

status*

Type: UinStatusType

Статус проверки УИНа:

  • FAILED — не прошел проверку.

  • IN_PROGRESS — в процессе проверки.

  • NOT_ON_VALIDATION — УИН не отправлен на проверку или переданы не все УИНы в заказе.

  • OK — проверка успешно пройдена.

Enum: OK, IN_PROGRESS, FAILED, NOT_ON_VALIDATION

value*

Type: string

УИН товара.

UinStatusType

Статус проверки УИНа:

  • FAILED — не прошел проверку.

  • IN_PROGRESS — в процессе проверки.

  • NOT_ON_VALIDATION — УИН не отправлен на проверку или переданы не все УИНы в заказе.

  • OK — проверка успешно пройдена.

Type

Description

UinStatusType

Enum: OK, IN_PROGRESS, FAILED, NOT_ON_VALIDATION

400 Bad Request

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

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[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

Уникальный идентификационный номер для ювелирных изделий.

Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК.