Промокоды

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

Работа с промокодами

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

GET https://api.lpmotor.ru/v1/promo

This endpoint allows you to get free cakes.

Query Parameters

NameTypeDescription

site_id

string

ID сайта

Headers

NameTypeDescription

X-Api-User-Id

string

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

Authorization

string

API-токен

[
  {
    "id": 0,
    "code": "string",
    "pos": 0,
    "is_enabled": true,
    "bonus_type": 0,
    "bonus_amount": 0,
    "bonus_amount_is_in_percentages": true,
    "time_limit_is_enabled": true,
    "d_on": "2021-08-04T13:57:37.243Z",
    "d_off": "2021-08-04T13:57:37.243Z",
    "quantity_limit_is_enabled": true,
    "quantity_limit": 0,
    "promo_used_count": 0,
    "is_valid": 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/promo?site_id=11111" 

Создание промокода

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

Headers

NameTypeDescription

X-Api-User-Id

string

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

Authorization

string

API-токен

Request Body

NameTypeDescription

site_id

integer

ID сайта

code

string

Код длиной от 2 до 15 символов. Может состоять только из букв латинского алфавита и цифр

is_enabled

boolean

Флаг действия промокода. По умолчанию: false

bonus_type

integer

Тип действия промокода. Поддерживаемые значения: 2 - на стоимость основных товаров, 3 - на стоимость доставки. По умолчанию: 2

bonus_amount

number

Сумма скидки. По умолчанию: 0.01

bonus_amount_is_in_percentages

boolean

Тип скидки. true - в процентах, false - фиксированная. По умолчанию: false

time_limit_is_enabled

boolean

Флаг ограничения срока действия промокода. По умолчанию: false

d_on

string

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

d_off

string

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

quantity_limit_is_enabled

boolean

Флаг ограничения количества использований промокода. По умолчанию: false

quantity_limit

integer

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

personal_limit_is_enabled

boolean

Флаг повторного использования промокода одним пользователем. По умолчанию: false

{
  "code": "string",
  "is_enabled": true,
  "bonus_type": 0,
  "bonus_amount": 0,
  "bonus_amount_is_in_percentages": true,
  "time_limit_is_enabled": true,
  "d_on": "2021-08-04T14:36:22.614Z",
  "d_off": "2021-08-04T14:36:22.614Z",
  "quantity_limit_is_enabled": true,
  "quantity_limit": 0,
  "personal_limit_is_enabled": 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/promo" \ 
-d '{"user_id":123,"site_id":11111,"code":"mypromocode"}'

Получение промокода по ID

GET https://api.lpmotor.ru/v1/promo/{promo_id}

Path Parameters

NameTypeDescription

promo_id

string

ID промокода

Headers

NameTypeDescription

X-Api-User-Id

string

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

Authorization

string

API-токен

{
  "code": "string",
  "is_enabled": true,
  "bonus_type": 0,
  "bonus_amount": 0,
  "bonus_amount_is_in_percentages": true,
  "time_limit_is_enabled": true,
  "d_on": "2021-08-04T14:39:18.248Z",
  "d_off": "2021-08-04T14:39:18.248Z",
  "quantity_limit_is_enabled": true,
  "quantity_limit": 0,
  "personal_limit_is_enabled": 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/promo/1" 

Изменение промокода

PUT https://api.lpmotor.ru/v1/promo/{promo_id}

Path Parameters

NameTypeDescription

promo_id

string

ID промокода

Headers

NameTypeDescription

X-Api-User-Id

string

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

Authorization

string

API-токен

Request Body

NameTypeDescription

code

string

Код длиной от 2 до 15 символов. Может состоять только из символов латиницы и цифр

is_enabled

boolean

Флаг действия промокода. По умолчанию: false

bonus_type

integer

Тип действия промокода. Поддерживаемые значения: 2 - на стоимость основных товаров, 3 - на стоимость доставки. По умолчанию: 2

bonus_amount

number

Сумма скидки. По умолчанию: 0.01

bonus_amount_is_in_percentages

boolean

Тип скидки. true - в процентах, false - фиксированная. По умолчанию: false

time_limit_is_enabled

boolean

Флаг ограничения срока действия промокода. По умолчанию: false

d_on

string

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

d_off

string

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

quantity_limit_is_enabled

boolean

Флаг ограничения количества использований промокода. По умолчанию: false

quantity_limit

integer

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

personal_limit_is_enabled

boolean

Флаг повторного использования промокода одним пользователем. По умолчанию: false

{
  "code": "string",
  "is_enabled": true,
  "bonus_type": 0,
  "bonus_amount": 0,
  "bonus_amount_is_in_percentages": true,
  "time_limit_is_enabled": true,
  "d_on": "2021-08-04T14:43:46.897Z",
  "d_off": "2021-08-04T14:43:46.897Z",
  "quantity_limit_is_enabled": true,
  "quantity_limit": 0,
  "personal_limit_is_enabled": 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/promo/1" \ 
-d '{"code":"newpromocode"}'

Удаление промокода

DELETE https://api.lpmotor.ru/v1/promo/{promo_id}

Path Parameters

NameTypeDescription

promo_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/promo/1" 

Получение статистики использования промокода

GET https://api.lpmotor.ru/v1/promo/{promo_id}/statistics

Path Parameters

NameTypeDescription

promo_id

string

ID промокода

Headers

NameTypeDescription

X-Api-User-Id

string

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

Authorization

string

API-токен

[
  {
    "id": 0,
    "promo_id": 0,
    "lead_id": 0,
    "bonus_type_id": 0,
    "bonus_amount": 0,
    "bonus_amount_is_in_percentages": 0,
    "order_price": 0,
    "order_quantity": 0,
    "discount_amount": 0,
    "promo": {
      "code": "string"
    },
    "d_lead_created": "2021-08-04T15:02:13.184Z",
    "currency": "string"
  }
]

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

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/promo/1/statistics"

Last updated