Перейти к содержимому
Omninet

Создание локаций

POST /v1/location/create

Тело запроса

Заголовок раздела «Тело запроса»
locations array
Список локаций для создания.
Показать Скрыть
merchant_location_id string
Идентификатор локации продавца (опционально).
location_types array
Типы локации; элементы — WAREHOUSE (склад), PICKUP_POINT (пункт выдачи) или CLICK_AND_COLLECT (пункт самовывоза). Набор задаётся при создании и определяет допустимую схему данных и валидацию полей локации.
Тип локации в массиве location_types.

- WAREHOUSE: склад.
- PICKUP_POINT: пункт выдачи.
- CLICK_AND_COLLECT: пункт самовывоза (Click & Collect).
name string
Название локации.
address_tail string
Адрес в текстовом формате (опционально).
comment string
Комментарий к доставке или адресу (опционально).
latitude number
Широта (опционально).
longitude number
Долгота (опционально).
provider_id string
Идентификатор провайдера доставки (опционально).
values
CDEKBOXBERRY5POSTRUSSIAN_POSTYANDEXSBLMVIDEO
provider_location_id string
Идентификатор локации у провайдера доставки (опционально).
pickup_point_type string
Тип пункта выдачи.

- PICKUP_POINT: пункт выдачи.
- POSTAMAT: постамат.
values
PICKUP_POINTPOSTAMAT
payment_methods array
Доступные способы оплаты на точке (опционально).
Способ оплаты на точке.

- ALREADY_PAID: предоплаченные заказы.
- CARD: оплата картой.
- CASH: оплата наличными.
storage_period_days integer
Число дней хранения заказа на точке (опционально).
limits object
Предельные габариты и вес заказа для точки (ВГХ, см и кг).
Показать Скрыть
length number
Максимальная длина заказа, см.
width number
Максимальная ширина заказа, см.
height number
Максимальная высота заказа, см.
weight number
Максимальный вес заказа, кг.
instruction string
Инструкция как добраться для отображения на витрине (опционально).
pickup_services array
Дополнительные услуги пункта выдачи (опционально).
Дополнительная услуга ПВЗ.

- FITTING: возможна примерка.
working_schedule array
Расписание работы.
Показать Скрыть
day string
День недели.
values
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY
schedule object
Расписание на день.
Показать Скрыть
time_start string
Время начала, формат «00:00».
time_end string
Время окончания, формат «00:00».
break string
Перерыв, формат «13:00–14:00».
shipping_cutoff string
Время, после которого отсчёт слота доставки начнётся со следующего дня. Формат «16:30». Если пустое — не применяется.
individual_schedule array
Индивидуальное расписание на определённые даты. К примеру, праздничные дни (опционально при отличии от working_schedule).
Показать Скрыть
date string
Дата, формат «YYYY-MM-DD».
schedule object
Расписание на дату.
Показать Скрыть
time_start string
Время начала, формат «00:00».
time_end string
Время окончания, формат «00:00».
break string
Перерыв, формат «13:00–14:00».
shipping_cutoff string
Время, после которого отсчёт слота доставки начнётся со следующего дня. Формат «16:30». Если пустое — не применяется.
is_works boolean
Признак работы в дату.
is_accepts_returns boolean
Признак приёма возвратов.

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

200 A successful response.
application/json
object
locations array
Результаты по каждой локации из тела запроса create (порядок соответствует массиву locations в запросе).
Итог по одной локации из batch create: location_id — id в системе витрины (пустая строка, если не создано); name — название из запроса; errors — ошибки валидации по полям, при успехе []. Поле issue в ответе create не передаётся.
Показать Скрыть
location_id string
Идентификатор локации в системе витрины; пустая строка, если операция для этой позиции не выполнена.
merchant_location_id string
Идентификатор локации продавца (опционально).
name string
Название локации из запроса.
status string
Статус локации после операции create.
values
DRAFTPENDINGACTIVEQUARANTINEFAILEDARCHIVED
errors array
Ошибки валидации по полям; пустой массив при успехе.
Ошибка валидации поля в элементе ответа по локации.
Показать Скрыть
field string
Имя поля в запросе (например address_tail).
code string
Код ошибки валидации (например REQUIRED).
message string
Текст ошибки для клиента.

Ошибки

400 Некорректный запрос
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
401 Ошибка авторизации
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
429 Превышен лимит запросов
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
500 Внутренняя ошибка сервера
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
POST /v1/location/create 

              1
              curl https://api.omninet.ru/v1/location/create \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "locations": [
            
              6
                  {
            
              7
                    "merchant_location_id": "string",
            
              8
                    "location_types": [
            
              9
                      "string"
            
              10
                    ],
            
              11
                    "name": "string",
            
              12
                    "address_tail": "string",
            
              13
                    "comment": "string",
            
              14
                    "latitude": 0,
            
              15
                    "longitude": 0,
            
              16
                    "provider_id": "string",
            
              17
                    "provider_location_id": "string",
            
              18
                    "pickup_point_type": "string",
            
              19
                    "payment_methods": [
            
              20
                      "string"
            
              21
                    ],
            
              22
                    "storage_period_days": 0,
            
              23
                    "limits": {
            
              24
                      "length": 0,
            
              25
                      "width": 0,
            
              26
                      "height": 0,
            
              27
                      "weight": 0
            
              28
                    },
            
              29
                    "instruction": "string",
            
              30
                    "pickup_services": [
            
              31
                      "string"
            
              32
                    ],
            
              33
                    "working_schedule": [
            
              34
                      {
            
              35
                        "day": "MONDAY",
            
              36
                        "schedule": {
            
              37
                          "time_start": "string",
            
              38
                          "time_end": "string",
            
              39
                          "break": "string",
            
              40
                          "shipping_cutoff": "string"
            
              41
                        }
            
              42
                      }
            
              43
                    ],
            
              44
                    "individual_schedule": [
            
              45
                      {
            
              46
                        "date": "string",
            
              47
                        "schedule": {
            
              48
                          "time_start": "string",
            
              49
                          "time_end": "string",
            
              50
                          "break": "string",
            
              51
                          "shipping_cutoff": "string"
            
              52
                        },
            
              53
                        "is_works": true
            
              54
                      }
            
              55
                    ],
            
              56
                    "is_accepts_returns": true
            
              57
                  }
            
              58
                ]
            
              59
              }'
            
{
  "locations": [
    {
      "location_id": "string",
      "merchant_location_id": "string",
      "name": "string",
      "status": "string",
      "errors": [
        {
          "field": "string",
          "code": "string",
          "message": "string"
        }
      ]
    }
  ]
}

A successful response.

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Некорректный запрос

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Ошибка авторизации

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Превышен лимит запросов

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Внутренняя ошибка сервера