Доставки

Получение списка доставок. Как создать, изменить или удалить доставки. Всё покажем с примерами на нашем сайте

Работа с доставками

Получение списка доставок

GET https://api.lpmotor.ru/v1/delivery/site/{site_id}

Path Parameters

NameTypeDescription

site_id

string

ID сайта

Headers

NameTypeDescription

X-Api-User-Id

string

ID пользователя

Authorization

string

API-токен

[
  {
    "id": 0,
    "template_id": 0,
    "site_id": 0,
    "title": "string",
    "price": "string",
    "free_start_from": "string",
    "creator_id": 0,
    "d_created": "2021-08-04T15:28:46.655Z",
    "d_updated": "2021-08-04T15:28:46.655Z",
    "enabled": true,
    "deleted": true,
    "points": [
      {
        "id": 0,
        "title": "string",
        "price": "string",
        "free_start_from": "string",
        "country": "string",
        "city": "string",
        "zip": "string",
        "street": "string",
        "building_number": "string",
        "office_number": "string",
        "floor": 0,
        "comment": "string",
        "enabled": true,
        "deleted": true
      }
    ],
    "regions": [
      {
        "id": 0,
        "title": "string",
        "price": "string",
        "free_start_from": "string",
        "comment": "string",
        "enabled": true,
        "deleted": true,
        "coordinates": [[0, 0],[0, 0],[0, 0]]
      }
    ],
    "additional_fields": [
      {
        "id": 0,
        "name": "string",
        "label": "string",
        "parent_id": "string"
      }
    ],
    "cities": [
      {
        "id": 0,
        "city_type": "string",
        "city": "string"
      }
    ],
    "pos": 0,
    "internal_info": {
      "tariff_code": 0,
      "from_city_code": 0,
      "pvz_code": "string",
      "sender_address": "string",
      "company_name": "string",
      "sender_name": "string",
      "sender_email": "string",
      "sender_phone": "string",
      "medium_width": 0,
      "medium_length": 0,
      "medium_height": 0,
      "medium_weight": 0,
      "calculation_type": "string",
      "added_value": 0,
      "need_create_order": true
    }
  }
]

Пример запроса

curl \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Api-User-Id: <<Your-user-id>>" \
-H "Authorization: Bearer <<Your-API-token>>" \
-X GET "https://api.lpmotor.ru/v1/delivery/site/11111"

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

POST https://api.lpmotor.ru/v1/delivery

Headers

NameTypeDescription

X-Api-User-Id

string

ID пользователя

Authorization

string

API-токен

Request Body

NameTypeDescription

template_id

integer

ID шаблона доставки. Возможные значения: 1 - универсальный, 2 - самовывоз, 3 - курьером, 4 - курьером с автоматическим подсчетом стоимости, 5 - через ТК CDEK

title

string

Название доставки

site_id

integer

ID сайта

price

number

Стоимость доставки. По умолчанию: 0

free_start_from

number

Минимальная стоимость заказа, начиная с которой доставка будет бесплатной. По умолчанию: 0

enabled

boolean

Флаг доступности доставки

regions

array

Районы доставки. Обязателен для шаблонов 3 и 4

regions[].title

string

Название района доставки

regions[].price

number

Стоимость доставки. По умолчанию: 0

regions[].free_start_from

number

Минимальная стоимость заказа, начиная с которой доставка будет бесплатной. По умолчанию: 0

regions[].comment

string

Подсказка для доставки. По умолчанию: null

regions[].enabled

boolean

Флаг доступности доставки

regions[].coordinates

array

Массив координат точек, определяющих район доставки. По умолчанию: null

points

array

Точки самовывоза. Обязателен для шаблона 2

points[].title

string

Название точки самовывоза

points[].price

number

Стоимость доставки. По умолчанию: 0

points[].free_start_from

number

Минимальная стоимость заказа, начиная с которой доставка будет бесплатной. По умолчанию: 0

points[].enabled

boolean

Флаг доступности доставки

points[].comment

string

Подсказка для доставки. По умолчанию: null

additional_fields

array

Дополнительные поля для доставки

additional_fields[].id

integer

ID дополнительного поля. Возможные значения: 1 - поле Адрес, 2 - поле с обязательным вводом адреса, 3 - поле Комментарий

cities

array

Города, в которых доступна доставка

cities[].id

integer

ID города

internal_info

object

Дополнительные данные для доставки. Обязателен для шаблона 5

internal_info.tariff_code

integer

Код тарифа в CDEK

internal_info.from_city_code

integer

Код города, из которого будет осуществлена доставка

internal_info.pvz_code

string

Код ПВЗ, на который будет доставлен заказ отправителем

internal_info.sender_address

string

Адрес отправителя

internal_info.company_name

string

Название компании отправителя

internal_info.sender_name

string

Имя отправителя

internal_info.sender_email

string

Электронный адрес отправителя

internal_info.sender_phone

string

Телефон отправителя

internal_info.medium_width

integer

Средняя ширина товара

internal_info.medium_length

integer

Средняя длина товара

internal_info.medium_height

integer

Средняя высота товара

internal_info.medium_weight

integer

Средний вес товара

internal_info.calculation_type

string

Тип стоимости доставки. Возможные значения: CALCULATION - расчет стоимости через CDEK, FIX_PRICE - фиксированная стоимость доставки

internal_info.added_value

number

Добавочная стоимость к текущей стоимости доставки

internal_info.need_create_order

boolean

Флаг автоматического создания доставки в CDEK

{
  "id": 0,
  "template_id": 0,
  "site_id": 0,
  "title": "string",
  "price": "string",
  "free_start_from": "string",
  "creator_id": 0,
  "d_created": "2021-08-06T11:49:34.828Z",
  "d_updated": "2021-08-06T11:49:34.828Z",
  "enabled": true,
  "deleted": true,
  "points": [
    {
      "id": 0,
      "title": "string",
      "price": "string",
      "free_start_from": "string",
      "country": "string",
      "city": "string",
      "zip": "string",
      "street": "string",
      "building_number": "string",
      "office_number": "string",
      "floor": 0,
      "comment": "string",
      "enabled": true,
      "deleted": true
    }
  ],
  "regions": [
    {
      "id": 0,
      "title": "string",
      "price": "string",
      "free_start_from": "string",
      "comment": "string",
      "enabled": true,
      "deleted": true,
      "coordinates": [[0, 0],[0, 0],[0, 0]]
    }
  ],
  "additional_fields": [
    {
      "id": 0,
      "name": "string",
      "label": "string",
      "parent_id": "string"
    }
  ],
  "cities": [
    {
      "id": 0,
      "city_type": "string",
      "city": "string"
    }
  ],
  "pos": 0,
  "internal_info": {
    "tariff_code": 0,
    "from_city_code": 0,
    "pvz_code": "string",
    "sender_address": "string",
    "company_name": "string",
    "sender_name": "string",
    "sender_email": "string",
    "sender_phone": "string",
    "medium_width": 0,
    "medium_length": 0,
    "medium_height": 0,
    "medium_weight": 0,
    "calculation_type": "string",
    "added_value": 0,
    "need_create_order": true
  }
}

Пример запроса

curl \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Api-User-Id: <<Your-user-id>>" \
-H "Authorization: Bearer <<Your-API-token>>" \
-X POST "https://api.lpmotor.ru/v1/delivery" \ 
-d '{"template_id":2,"title":"delivery name","site_id":11111,"enabled":true,"regions":[],"points":[{"title":"test point","comment":"this is comment","enabled":true}],"additional_fields":[{"id":1},{"id":2}]}'

Получение доставки по ID

GET https://api.lpmotor.ru/v1/delivery/{delivery_id}

Path Parameters

NameTypeDescription

delivery_id

string

ID доставки

Headers

NameTypeDescription

X-Api-User-Id

string

ID пользователя

Authorization

string

API-токен

{
  "id": 0,
  "template_id": 0,
  "site_id": 0,
  "title": "string",
  "price": "string",
  "free_start_from": "string",
  "creator_id": 0,
  "d_created": "2021-08-06T13:13:39.239Z",
  "d_updated": "2021-08-06T13:13:39.239Z",
  "enabled": true,
  "deleted": true,
  "points": [
    {
      "id": 0,
      "title": "string",
      "price": "string",
      "free_start_from": "string",
      "country": "string",
      "city": "string",
      "zip": "string",
      "street": "string",
      "building_number": "string",
      "office_number": "string",
      "floor": 0,
      "comment": "string",
      "enabled": true,
      "deleted": true
    }
  ],
  "regions": [
    {
      "id": 0,
      "title": "string",
      "price": "string",
      "free_start_from": "string",
      "comment": "string",
      "enabled": true,
      "deleted": true,
      "coordinates": [[0, 0],[0, 0],[0, 0]]
    }
  ],
  "additional_fields": [
    {
      "id": 0,
      "name": "string",
      "label": "string",
      "parent_id": "string"
    }
  ],
  "cities": [
    {
      "id": 0,
      "city_type": "string",
      "city": "string"
    }
  ],
  "pos": 0,
  "internal_info": {
    "tariff_code": 0,
    "from_city_code": 0,
    "pvz_code": "string",
    "sender_address": "string",
    "company_name": "string",
    "sender_name": "string",
    "sender_email": "string",
    "sender_phone": "string",
    "medium_width": 0,
    "medium_length": 0,
    "medium_height": 0,
    "medium_weight": 0,
    "calculation_type": "string",
    "added_value": 0,
    "need_create_order": true
  }
}

Пример запроса

curl \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Api-User-Id: <<Your-user-id>>" \
-H "Authorization: Bearer <<Your-API-token>>" \
-X GET "https://api.lpmotor.ru/v1/delivery/1" 

Изменение доставки

PUT https://api.lpmotor.ru/v1/delivery

Headers

NameTypeDescription

X-Api-User-Id

string

ID пользователя

Authorization

string

API-токен

Request Body

NameTypeDescription

id

integer

ID доставки

title

string

Название доставки

price

number

Стоимость доставки. По умолчанию: 0

free_start_from

number

Минимальная стоимость заказа, начиная с которой доставка будет бесплатной. По умолчанию: 0

enabled

boolean

Флаг доступности доставки

pos

integer

Позиция доставки в списке

regions

array

Районы доставки. Обязателен для шаблонов 3 и 4

regions[].id

integer

ID района доставки

regions[].title

string

Название района доставки

regions[].price

number

Стоимость доставки. По умолчанию: 0

regions[].free_start_from

number

Минимальная стоимость доставки, начиная с которой доставка будет бесплатной. По умолчанию: 0

regions[].comment

string

Подсказка для доставки. По умолчанию: null

regions[].enabled

boolean

Флаг доступности района доставки

regions[].coordinates

array

Массив координат точек, определяющих район доставки. По умолчанию: null

points

array

Точки самовывоза. Обязателен для шаблона 2

points[].id

integer

ID точки самовывоза

points[].title

string

Название точки самовывоза

points[].price

number

Стоимость доставки. По умолчанию: 0

points[].free_start_from

number

Минимальная стоимость заказа, начиная с которой доставка будет бесплатной. По умолчанию: 0

points[].enabled

boolean

Флаг доступности доставки

points[].comment

string

Подсказка для доставки. По умолчанию: null

additional_fields

array

Дополнительные поля для доставки

additional_fields[].id

integer

ID дополнительного поля. Возможные значения: 1 - поле Адрес, 2 - поле с обязательным вводом адреса, 3 - поле Комментарий

cities

array

Города, в которых доступна доставка

cities[].id

integer

ID города

internal_info

object

Дополнительные данные для доставки. Обязателен для шаблона 5

internal_info.tariff_code

integer

Код тарифа в CDEK

internal_info.from_city_code

integer

Код города, из которого будет осуществлена доставка

internal_info.pvz_code

string

Код ПВЗ, в который будет доставлен заказ отправителем

internal_info.sender_address

string

Адрес отправителя

internal_info.company_name

string

Название компании отправителя

internal_info.sender_name

string

Имя отправителя

internal_info.sender_email

string

Электронный адрес отправителя

internal_info.sender_phone

string

Телефон отправителя

internal_info.medium_width

integer

Средняя ширина товара

internal_info.medium_length

integer

Средняя длина товара

internal_info.medium_height

integer

Средняя высота товара

internal_info.medium_weight

integer

Средний вес товара

internal_info.calculation_type

string

Тип стоимости доставки. Возможные значения: CALCULATION - расчет стоимости через CDEK, FIX_PRICE - фиксированная стоимость доставки

internal_info.added_value

number

Добавочная стоимость к текущей стоимости доставки

internal_info.need_create_order

boolean

Флаг автоматического создания доставки в CDEK

{
  "id": 0,
  "title": "string",
  "price": 0,
  "free_start_from": 0,
  "enabled": true,
  "pos": 0,
  "regions": [
    {
      "id": 0,
      "title": "string",
      "price": 0,
      "free_start_from": 0,
      "comment": "string",
      "enabled": true,
      "coordinates": [
        [
          0, 0
        ]
      ]
    }
  ],
  "points": [
    {
      "id": 0,
      "title": "string",
      "price": 0,
      "free_start_from": 0,
      "country": "string",
      "city": "string",
      "zip": "string",
      "street": "string",
      "building_number": "string",
      "office_number": "string",
      "floor": 0,
      "comment": "string",
      "enabled": true
    }
  ],
  "additional_fields": [
    {
      "id": 0
    }
  ],
  "cities": [
    {
      "id": 0
    }
  ],
  "internal_info": {
    "tariff_code": 0,
    "from_city_code": 0,
    "pvz_code": "string",
    "sender_address": "string",
    "company_name": "string",
    "sender_name": "string",
    "sender_email": "string",
    "sender_phone": "string",
    "medium_width": 0,
    "medium_length": 0,
    "medium_height": 0,
    "medium_weight": 0,
    "calculation_type": "string",
    "added_value": 0,
    "need_create_order": true
  }
}

Пример запроса

curl \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Api-User-Id: <<Your-user-id>>" \
-H "Authorization: Bearer <<Your-API-token>>" \
-X PUT "https://api.lpmotor.ru/v1/delivery" \ 
-d '{"id":1,"title":"new delivery name","enabled":false,"pos":1,"points":[],"regions":[{"id":1,"title":"new region name","enabled":true}]}'

Удаление доставки

DELETE https://api.lpmotor.ru/v1/delivery/{delivery_id}

Path Parameters

NameTypeDescription

delivery_id

string

ID доставки

Headers

NameTypeDescription

X-Api-User-Id

string

ID пользователя

Authorization

string

API-токен

Пример запроса

curl \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Api-User-Id: <<Your-user-id>>" \
-H "Authorization: Bearer <<Your-API-token>>" \
-X DELETE "https://api.lpmotor.ru/v1/delivery/1" 

Last updated