Обновление адреса доставки

POST /v1/order/dbs/delivery-address/set

POST/v1/order/dbs/delivery-address/set

Тело запроса

merchant_order_id
string
Идентификатор заказа продавца.
delivery
object
Параметры доставки курьером или выдачи в ПВЗ.
Показать свойства
delivery_type
string
required
Тип доставки или выдачи. - COURIER: доставка курьером — обязателен address_tail. - PICKUP_POINT: доставка в пункт выдачи. - CLICK_AND_COLLECT: самовывоз (Click & Collect).
Допустимые значения
COURIERPICKUP_POINTCLICK_AND_COLLECT
address_tail
string
Адрес в текстовом формате. Обязателен при delivery_type = COURIER. Формат: «196653, Россия, г. Санкт-Петербург, г. Колпино, ул. Октябрьская, д. 77/27, подъезд 1, этаж 3, кв. 12».
comment
string
Комментарий к доставке или адресу.
latitude
number
Широта.
provider_location_id
string
Идентификатор локации у провайдера доставки.
longitude
number
Долгота.
city
string
Город (опционально).
postal_code
string
Индекс (опционально).

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

200A successful response.
application/json
object
failed
object
Ошибка изменения адреса. Если отсутствует — успех.
Показать свойства
merchant_order_id
string
Идентификатор заказа продавца.
error_message
string
Текст ошибки (compat). Предпочтительно использовать errors.
errors
array
Структурированные ошибки. Коды: OrderDeliveryAddressValidationErrorCode.
Ошибка валидации/бизнеса поля для scope «OrderDeliveryAddress». Допустимые field: merchant_order_id, delivery.*, city, postal_code. Для бизнес-правил витрины: code=STOREFRONT_RULE_VIOLATION.
Показать свойства
field
string
required
Путь к полю. Ожидаемые: merchant_order_id, delivery.*, city, postal_code.
code
string
required
Коды ошибок ручки (scope OrderDeliveryAddress). Допустимые field: merchant_order_id, delivery.*, city, postal_code. - REQUIRED: Поле отсутствует или пустое, но обязательно - INVALID_TYPE: Неверный JSON-тип - INVALID_FORMAT: Общий сбой формата значения - INVALID_ENUM: Значение не из допустимого enum - CONDITIONALLY_REQUIRED: Поле обязательно при выполнении условия - INVALID_ADDRESS_FORMAT: Адрес не соответствует шаблону - INVALID_LATITUDE: Широта вне диапазона - INVALID_LONGITUDE: Долгота вне диапазона - NOT_FOUND: Сущность не найдена (уточняется полем field) - STOREFRONT_RULE_VIOLATION: Запрос синтаксически валиден, но отклонён бизнес-правилом витрины (детали в message)
Допустимые значения
REQUIREDINVALID_TYPEINVALID_FORMATINVALID_ENUMCONDITIONALLY_REQUIREDINVALID_ADDRESS_FORMATINVALID_LATITUDEINVALID_LONGITUDENOT_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/delivery-address/set
1curl https://api.omninet.ru/v1/order/dbs/delivery-address/set \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "merchant_order_id": "string",6  "delivery": {7    "delivery_type": "string",8    "address_tail": "string",9    "comment": "string",10    "latitude": 0,11    "provider_location_id": "string",12    "longitude": 013  },14  "city": "string",15  "postal_code": "string"16}'
{
  "failed": {
    "merchant_order_id": "string",
    "error_message": "string",
    "errors": [
      {
        "field": "delivery.address_tail",
        "code": "INVALID_ADDRESS_FORMAT",
        "message": "Адрес не по шаблону"
      }
    ]
  }
}

A successful response.