Передача кода вручения по заказам продавца

POST /v1/order/dbs/handover-code/set

POST/v1/order/dbs/handover-code/set

Если в одном запросе передано несколько записей с одинаковым merchant_order_id, при обработке учитывается последняя запись, предыдущие игнорируются.

Тело запроса

handoverCodes

array

Список кодов вручения по заказам продавца. Максимальное количество элементов в одном запросе — 200.

OrderHandoverCodeUpdateItem

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

OrderHandoverCodeUpdateItem

merchant_order_id

string

required

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

code

string

required

Код вручения заказа.

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

200A successful response.

application/json

object

processed

integer

Количество успешно обработанных элементов.

failed

array

Элементы батча с ошибкой. Пустой/отсутствует — все успешно.

Элемент батча с ошибкой. Коды — OrderHandoverValidationErrorCode.

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

merchant_order_id

string

required

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

error_message

string

Краткий текст (compat). Предпочтительно errors.

errors

array

Ошибки полей элемента.

Ошибка валидации/бизнеса поля для scope «OrderHandover». Допустимые field: handover_codes[].merchant_order_id, handover_codes[].code. Для бизнес-правил витрины: code=STOREFRONT_RULE_VIOLATION.

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

field

string

required

Путь к полю. Ожидаемые: handover_codes[].merchant_order_id, handover_codes[].code.

code

string

required

Код ошибки.

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

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

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

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

CONFLICT: Конфликт состояния

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

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

REQUIREDINVALID_TYPEINVALID_FORMATNOT_FOUNDCONFLICTSTOREFRONT_RULE_VIOLATION

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/handover-code/set

1curl https://api.omninet.ru/v1/order/dbs/handover-code/set \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "handoverCodes": [6    {7      "merchant_order_id": "string",8      "code": "string"9    }10  ]11}'

{
  "processed": 0,
  "failed": [
    {
      "merchant_order_id": "string",
      "error_message": "string",
      "errors": [
        {
          "field": "code",
          "code": "REQUIRED",
          "message": "Код вручения обязателен"
        }
      ]
    }
  ]
}

A successful response.