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

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

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

Метод изменяет (обновляет) ранее установленный адрес доставки заказа.

Тело запроса

merchant_order_id

string

required

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

delivery

object

Параметры доставки курьером или выдачи в ПВЗ.

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

delivery_type

string

required

Тип доставки или выдачи.

COURIER: доставка курьером — обязателен address_tail

PICKUP_POINT: доставка в пункт выдачи

CLICK_AND_COLLECT: самовывоз (Click & Collect)

EXPRESS: срочная курьерская доставка заказа клиенту — обязателен address_tail (аналогично COURIER)

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

COURIERPICKUP_POINTCLICK_AND_COLLECTEXPRESS

address_tail

string

Адрес в текстовом формате. Обязателен при delivery_type = COURIER или EXPRESS. Формат: «196653, Россия, г. Санкт-Петербург, г. Колпино, ул. Октябрьская, д. 77/27, подъезд 1, этаж 3, кв. 12».

comment

string

Комментарий к доставке или адресу.

latitude

number

Широта.

longitude

number

Долгота.

provider_location_id

string

Идентификатор локации у провайдера доставки.

provider_id

string

Идентификатор провайдера доставки.

CDEK: СДЭК

RUSSIAN_POST: Почта России

BOXBERRY: Boxberry

YANDEX: Яндекс Доставка

5POST: 5Post

DPD: DPD

HERMES: Hermes

IML: IML

TOP_DELIVERY: Top Delivery

OZON: Ozon

KSE: КСЕ

STRIZH: Стриж

DL: Деловые Линии

PEK: ПЭК

SBL: Сберлогистика

MVIDEO: М.Видео

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

CDEKRUSSIAN_POSTBOXBERRYYANDEX5POSTDPDHERMESIMLTOP_DELIVERYOZONKSESTRIZHDLPEKSBLMVIDEO

city

string

Город.

postal_code

string

Индекс.

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

200A successful response.

application/json

object

merchant_order_id

string

required

Идентификатор заказа продавца. Всегда присутствует (успех и ошибка).

errors

array

Структурированные ошибки (только при неуспехе). Коды — OrderDeliveryAddressValidationErrorCode.

При ошибке — только merchant_order_id + errors.

Ошибка валидации/бизнеса поля для 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

Код ошибки.

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

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

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

INVALID_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

Класс транспортной ошибки запроса (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/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    "longitude": 0,12    "provider_location_id": "string",13    "provider_id": "string"14  },15  "city": "string",16  "postal_code": "string"17}'

{
  "merchant_order_id": "string",
  "errors": [
    {
      "field": "delivery.address_tail",
      "code": "INVALID_ADDRESS_FORMAT",
      "message": "Адрес не по шаблону"
    }
  ]
}

A successful response.