Установка статуса возврата

POST /v1/return/dbs/status/set

POST/v1/return/dbs/status/set

Тело запроса

return_id
string
Идентификатор заявки на возврат.
status
string
Статус возврата.
Допустимые значения
PENDINGNEEDS_INFOREJECT_PENDINGPARTIAL_REFUNDDELIVERY_APPROVEDDELIVERINGDELIVEREDAPPROVEDREJECT_REFUNDDELIVERY_TO_CLIENTCANCELED
partial_refund_amount
number
Сумма частичной денежной компенсации (опционально).

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

200A successful response.
application/json
object
failed
object
Ошибка обновления статуса возврата. Если отсутствует — операция выполнена успешно.
Показать свойства
return_id
string
Идентификатор заявки на возврат.
error_message
string
Текст ошибки (compat). Предпочтительно использовать errors.
errors
array
Структурированные ошибки. Коды: ReturnStatusValidationErrorCode.
Ошибка валидации/бизнеса поля для scope «ReturnStatus». Допустимые field: return_id, status, partial_refund_amount. Для бизнес-правил витрины: code=STOREFRONT_RULE_VIOLATION.
Показать свойства
field
string
required
Путь к полю. Ожидаемые: return_id, status, partial_refund_amount.
code
string
required
Коды ошибок ручки (scope ReturnStatus). Допустимые field: return_id, status, partial_refund_amount. - REQUIRED: Поле отсутствует или пустое, но обязательно - INVALID_TYPE: Неверный JSON-тип - INVALID_FORMAT: Общий сбой формата значения - INVALID_ENUM: Значение не из допустимого enum - NEGATIVE_VALUE: Отрицательное значение недопустимо - MIN_VALUE: Значение ниже минимума - NOT_FOUND: Сущность не найдена (уточняется полем field) - INVALID_STATUS_TRANSITION: Недопустимый переход статуса - STATUS_NOT_ALLOWED: Статус недоступен в текущем контексте - CONFLICT: Конфликт состояния ресурса - STOREFRONT_RULE_VIOLATION: Запрос синтаксически валиден, но отклонён бизнес-правилом витрины (детали в message)
Допустимые значения
REQUIREDINVALID_TYPEINVALID_FORMATINVALID_ENUMNEGATIVE_VALUEMIN_VALUENOT_FOUNDINVALID_STATUS_TRANSITIONSTATUS_NOT_ALLOWEDCONFLICTSTOREFRONT_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/status/set
1curl https://api.omninet.ru/v1/return/dbs/status/set \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "return_id": "string",6  "status": "string",7  "partial_refund_amount": 08}'
{
  "failed": {
    "return_id": "string",
    "error_message": "string",
    "errors": [
      {
        "field": "status",
        "code": "INVALID_STATUS_TRANSITION",
        "message": "Недопустимый переход статуса возврата"
      }
    ]
  }
}

A successful response.