Передача сведений об экземплярах товаров

POST /v1/order/dbs/exemplar/set

POST/v1/order/dbs/exemplar/set

Тело запроса

merchant_order_id
string
Идентификатор заказа продавца.
product_id
string
Идентификатор товара в системе маркетплейса.
offer_id
string
Идентификатор товара в системе продавца — артикул.
exemplar
object
Информация об экземпляре товара.
Показать свойства
exemplar_id
string
Идентификатор экземпляра.
gtd
string
Номер грузовой таможенной декларации (ГТД).
marks
array
Контрольные знаки и другие маркировки.
OrderExemplarMark
Показать свойства
OrderExemplarMark
mark
string
Значение кода маркировки.
mark_type
string
Тип маркировки: mandatory_mark, jw_uin, imei.
rnpt
string
Регистрационный номер партии товара (РНПТ).
weight
number
Фактический вес экземпляра (опционально), кг.

Успешный ответ

200A successful response.
application/json
object
merchant_order_id
string
Идентификатор заказа мерчанта.
status
string
Статус обработки запроса.
Допустимые значения
ACCEPTED
errors
array
Ошибки валидации по полям; пустой массив при успехе. Коды только из OrderExemplarValidationErrorCode.
Ошибка валидации/бизнеса поля для scope «OrderExemplar». Допустимые field: merchant_order_id, product_id, offer_id, exemplar.*. Для бизнес-правил витрины: code=STOREFRONT_RULE_VIOLATION.
Показать свойства
field
string
required
Путь к полю. Ожидаемые: merchant_order_id, product_id, offer_id, exemplar.*.
code
string
required
Коды ошибок ручки (scope OrderExemplar). Допустимые field: merchant_order_id, product_id, offer_id, exemplar.*. - REQUIRED: Поле отсутствует или пустое, но обязательно - INVALID_TYPE: Неверный JSON-тип - INVALID_FORMAT: Общий сбой формата значения - INVALID_ENUM: Значение не из допустимого enum - CONDITIONALLY_REQUIRED: Поле обязательно при выполнении условия - MIN_VALUE: Значение ниже минимума - NEGATIVE_VALUE: Отрицательное значение недопустимо - NOT_FOUND: Сущность не найдена (уточняется полем field) - STOREFRONT_RULE_VIOLATION: Запрос синтаксически валиден, но отклонён бизнес-правилом витрины (детали в message)
Допустимые значения
REQUIREDINVALID_TYPEINVALID_FORMATINVALID_ENUMCONDITIONALLY_REQUIREDMIN_VALUENEGATIVE_VALUENOT_FOUNDSTOREFRONT_RULE_VIOLATION
message
string
required
Текст для клиента. Для STOREFRONT_RULE_VIOLATION — описание правила.

Ошибки

400Некорректный запрос
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
401Ошибка авторизации
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
429Превышен лимит запросов
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
POST/v1/order/dbs/exemplar/set
1curl https://api.omninet.ru/v1/order/dbs/exemplar/set \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "merchant_order_id": "string",6  "product_id": "string",7  "offer_id": "string",8  "exemplar": {9    "exemplar_id": "string",10    "gtd": "string",11    "marks": [12      {13        "mark": "string",14        "mark_type": "string"15      }16    ],17    "rnpt": "string",18    "weight": 019  }20}'
{
  "merchant_order_id": "string",
  "status": "string",
  "errors": [
    {
      "field": "exemplar.weight",
      "code": "NEGATIVE_VALUE",
      "message": "Вес не может быть отрицательным"
    }
  ]
}

A successful response.