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

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
integer

Идентификатор экземпляра.

gtd
string

Номер грузовой таможенной декларации (ГТД).

marks
array

Контрольные знаки и другие маркировки.

OrderExemplarMark

Показать свойства

OrderExemplarMark

mark
string

Значение кода маркировки.

mark_type
string

Тип маркировки: mandatory_mark, jw_uin, imei.

rnpt
string

Регистрационный номер партии товара (РНПТ).

weight
number

Фактический вес экземпляра, кг.

merchant_price
integer

Цена продавца (MERCHANT_PRICE) после определения фактического веса, до скидок; значение умножено на 100.

currency_code
string

Валюта merchant_price (как в orders[].prices[]).

  • RUB: Российский рубль
  • BYN: Белорусский рубль
  • KZT: Тенге
  • EUR: Евро
  • USD: Доллар США
  • CNY: Юань
Допустимые значения
RUBBYNKZTEURUSDCNY
vat
string

НДС для merchant_price (как в orders[].prices[]).

VAT_0: Ставка НДС 0%

VAT_5: Ставка НДС 5%

VAT_7: Ставка НДС 7%

VAT_10: Ставка НДС 10%

VAT_22: Ставка НДС 22%

NO_VAT: Без НДС

Допустимые значения
VAT_0VAT_5VAT_7VAT_10VAT_22NO_VAT

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

200A successful response.
application/json
object
merchant_order_id
string

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

status
string

Результат успешной обработки запроса. Поле возвращается только если переданные данные приняты и применены.

  • ACCEPTED: Переданные данные приняты и применены.
Допустимые значения
ACCEPTED
errors
array

Ошибки валидации по полям; пустой массив при успехе. При непустом errors поле status отсутствует — данные запроса не применены. Коды только из OrderExemplarValidationErrorCode.

Ошибка валидации/бизнеса поля для scope «OrderExemplar». Допустимые field: merchant_order_id, product_id, offer_id, exemplar.*, merchant_price, currency_code, vat. Для бизнес-правил витрины: code=STOREFRONT_RULE_VIOLATION.

Ошибка валидации/бизнеса поля для scope «OrderExemplar». Допустимые field: merchant_order_id, product_id, offer_id, exemplar.*, merchant_price, currency_code, vat. Для бизнес-правил витрины: code=STOREFRONT_RULE_VIOLATION.

Показать свойства
field
string
required

Путь к полю. Ожидаемые: merchant_order_id, product_id, offer_id, exemplar.*, merchant_price, currency_code, vat.

code
string
required

Код ошибки.

REQUIRED: Поле отсутствует или пустое, но обязательно

INVALID_TYPE: Неверный JSON-тип

INVALID_FORMAT: Неверный формат значения

INVALID_ENUM: Значение не из допустимого набора

CONDITIONALLY_REQUIRED: Поле обязательно при выполнении условия

MIN_VALUE: Значение ниже минимума

NEGATIVE_VALUE: Отрицательное значение недопустимо

NOT_FOUND: Сущность не найдена (уточняется полем field)

STOREFRONT_RULE_VIOLATION: Отклонено бизнес-правилом витрины (детали в message)

  • STATUS_NOT_ALLOWED: Операция недоступна в текущем статусе заказа (например, DELIVERING и позже)
Допустимые значения
REQUIREDINVALID_TYPEINVALID_FORMATINVALID_ENUMCONDITIONALLY_REQUIREDMIN_VALUENEGATIVE_VALUENOT_FOUNDSTOREFRONT_RULE_VIOLATIONSTATUS_NOT_ALLOWED
message
string
required

Текст для клиента. Для STOREFRONT_RULE_VIOLATION — описание правила.

Ошибки

400Некорректный запрос
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
401Ошибка авторизации
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
429Превышен лимит запросов
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

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": 0,10    "gtd": "string",11    "marks": [12      {13        "mark": "string",14        "mark_type": "string"15      }16    ],17    "rnpt": "string",18    "weight": 019  },20  "merchant_price": 0,21  "currency_code": "RUB",22  "vat": "string"23}'
{
  "merchant_order_id": "string",
  "status": "string",
  "errors": [
    {
      "field": "exemplar.weight",
      "code": "NEGATIVE_VALUE",
      "message": "Вес не может быть отрицательным"
    }
  ]
}

A successful response.