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

POST /v1/return/dbs/exemplar/update

POST/v1/return/dbs/exemplar/update

Тело запроса

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

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

200A successful response.
application/json
object
failed
object
Ошибка обновления сведений об экземпляре возврата. Если отсутствует — операция выполнена успешно.
Показать свойства
return_id
string
Идентификатор заявки на возврат.
error_message
string
Текст ошибки (compat). Предпочтительно использовать errors.
errors
array
Структурированные ошибки. Коды: ReturnExemplarValidationErrorCode.
Ошибка валидации/бизнеса поля для scope «ReturnExemplar». Допустимые field: return_id, exemplar.*. Для бизнес-правил витрины: code=STOREFRONT_RULE_VIOLATION.
Показать свойства
field
string
required
Путь к полю. Ожидаемые: return_id, exemplar.*.
code
string
required
Коды ошибок ручки (scope ReturnExemplar). Допустимые field: return_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/return/dbs/exemplar/update
1curl https://api.omninet.ru/v1/return/dbs/exemplar/update \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "return_id": "string",6  "exemplar": {7    "exemplar_id": "string",8    "gtd": "string",9    "marks": [10      {11        "mark": "string",12        "mark_type": "string"13      }14    ],15    "rnpt": "string",16    "weight": 017  }18}'
{
  "failed": {
    "return_id": "string",
    "error_message": "string",
    "errors": [
      {
        "field": "exemplar.exemplar_id",
        "code": "NOT_FOUND",
        "message": "Экземпляр не найден"
      }
    ]
  }
}

A successful response.