Создание полигонов доставки

POST /v1/polygon/create

Полигон создаётся в статусе DRAFT. Статус обработки полигона витриной можно получить методом /polygon/list.

Тело запроса

polygons array

Список полигонов для создания.

Показать Скрыть

name string

Название полигона.

coordinates array

Контур полигона в формате RFC 7946: массив линейных колец В JSON передаётся как массив линейных колец: первое кольцо — внешняя граница, последующие — отверстия. Позиция задаётся как [долгота(longitude), широта(latitude)] в градусах, система координат WGS 84 (долгота первой компонентой). Пример: [[[37.61, 55.75], [37.62, 55.76]], [[37.70, 55.80], [37.71, 55.81]]].

Линейное кольцо (LinearRing).

delivery_options array

Список цен доставки по объёмному весу.

Опция доставки по диапазону объёмного веса.

Показать Скрыть

volume_weight_from number

Объёмный вес (кг) от: длина (см) × ширина (см) × высота (см) * масса брутто (кг) / 300.

volume_weight_to number

Объёмный вес (кг) до: длина (см) × ширина (см) × высота (см) * масса брутто (кг) / 300.

price number

Цена доставки.

vat string

НДС.

values

VAT_0VAT_5VAT_7VAT_22NO_VAT

provider_id string

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

values

CDEKBOXBERRY5POSTRUSSIAN_POSTYANDEXSBLMVIDEO

delivery_time_minutes integer

Время доставки в минутах.

delivery_types array

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

Параметры типа доставки для опции.

Показать Скрыть

delivery_type string required

Тип доставки.

values

COURIERPICKUP_POINT

weight_from number

Вес (кг) от.

weight_to number

Вес (кг) до.

time_slots array

Доступные интервалы доставки по времени (опционально).

Интервал времени доставки в течение дня (локальное время).

Показать Скрыть

from string

Начало интервала, формат «HH:MM» (например, «10:00»).

to string

Конец интервала, формат «HH:MM» (например, «12:00»).

trunk_schedule object

График магистральной перевозки по городу; если не заполнен — не применяется.

Показать Скрыть

working_schedule array

Расписание по дням недели; в каждом элементе — day и shipping_cutoff для магистрали.

Показать Скрыть

day string

День недели.

values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

shipping_cutoff string

Время, после которого отсчёт слота доставки начнётся со следующего дня магистральной перевозки. Формат «16:30». Если пустое — не применяется.

individual_schedule array

Индивидуальное расписание на даты; в каждом элементе — date, shipping_cutoff для магистрали, is_works.

Показать Скрыть

date string

Дата, формат «YYYY-MM-DD».

shipping_cutoff string

Время, после которого отсчёт слота доставки начнётся со следующего дня магистральной перевозки. Формат «16:30». Если пустое — не применяется.

is_works boolean

Признак работы в дату.

location_id string

Идентификатор склада (опционально).

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

200 A successful response.

application/json

object

polygons array

Список созданных полигонов.

Показать Скрыть

polygon_id string

Идентификатор созданного полигона.

name string

Название полигона из запроса на создание.

status string

Статус полигона.
DRAFT: создан.
PENDING: в обработке.
ACTIVE: активен.
FAILED: не прошёл модерацию.
DELETED: удален.

values

DRAFTPENDINGACTIVEFAILEDDELETED

errors array

Список ошибок.

Показать Скрыть

field string

Имя поля в запросе (например, delivery_time_minutes).

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/polygon/create

Copy

              1
              curl https://api.omninet.ru/v1/polygon/create \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "polygons": [
            
              6
                  {
            
              7
                    "name": "string",
            
              8
                    "coordinates": [
            
              9
                      [
            
              10
                        [
            
              11
                          100,
            
              12
                          0
            
              13
                        ],
            
              14
                        [
            
              15
                          101,
            
              16
                          0
            
              17
                        ],
            
              18
                        [
            
              19
                          101,
            
              20
                          1
            
              21
                        ],
            
              22
                        [
            
              23
                          100,
            
              24
                          1
            
              25
                        ],
            
              26
                        [
            
              27
                          100,
            
              28
                          0
            
              29
                        ]
            
              30
                      ]
            
              31
                    ],
            
              32
                    "delivery_options": [
            
              33
                      {
            
              34
                        "volume_weight_from": 0,
            
              35
                        "volume_weight_to": 0,
            
              36
                        "price": 0,
            
              37
                        "vat": "string",
            
              38
                        "provider_id": "string",
            
              39
                        "delivery_time_minutes": 0,
            
              40
                        "delivery_types": [
            
              41
                          {
            
              42
                            "delivery_type": "COURIER"
            
              43
                          }
            
              44
                        ],
            
              45
                        "weight_from": 0,
            
              46
                        "weight_to": 0,
            
              47
                        "time_slots": [
            
              48
                          {
            
              49
                            "from": "string",
            
              50
                            "to": "string"
            
              51
                          }
            
              52
                        ],
            
              53
                        "trunk_schedule": {
            
              54
                          "working_schedule": [
            
              55
                            {
            
              56
                              "day": "MONDAY",
            
              57
                              "shipping_cutoff": "string"
            
              58
                            }
            
              59
                          ],
            
              60
                          "individual_schedule": [
            
              61
                            {
            
              62
                              "date": "string",
            
              63
                              "shipping_cutoff": "string",
            
              64
                              "is_works": true
            
              65
                            }
            
              66
                          ]
            
              67
                        }
            
              68
                      }
            
              69
                    ],
            
              70
                    "location_id": "string"
            
              71
                  }
            
              72
                ]
            
              73
              }'
            

200 400 401 429 500

{
  "polygons": [
    {
      "polygon_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": {}
}

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