Получение офлайн-акций
Параметры
HTTP метод | Права доступа | URL | Параметры | Примечание |
---|---|---|---|---|
GET | offline_sales | https://api.admitad.com/ |
Список параметров для запроса | Возвращает список акций*. |
GET | offline_sales | https://api.admitad.com/ |
Возвращает акцию*, где id — это идентификатор акции. |
- * Возвращает результат в формате JSON.
Список параметров для запроса
Название | Тип | Допустимые значения |
---|---|---|
campaign | integer | Список партнерских программ |
disabled | string |
|
datetime_start_from | datetime | %d.%m.%Y %H:%M |
datetime_start_to | datetime | %d.%m.%Y %H:%M |
datetime_end_from | datetime | %d.%m.%Y %H:%M |
datetime_end_to | datetime | %d.%m.%Y %H:%M |
datetime_created_from | datetime | %d.%m.%Y %H:%M |
datetime_created_to | datetime | %d.%m.%Y %H:%M |
limit | integer | Параметры limit, offset |
offset | integer | Параметры limit, offset |
is_activation_required | string |
|
Пример использования
Пример запроса с использованием утилиты curl:
curl -L -H 'Authorization: Bearer access_token' -X GET
https://api.admitad.com/offline_sales/?limit=1&disabled=false
curl -L -H 'Authorization: Bearer access_token' -X GET
https://api.admitad.com/offline_sales/3/
Пример ответа API-сервера в формате JSON:
{
"results": [
{
"campaign_id": 748,
"campaign_name": "foo campaign name",
"currency": "USD",
"description": "foo description",
"disabled": false,
"id": 3,
"image": "https://www.admitad.com/public/ceVbXte.jpg",
"name": "foo name",
"rate": "100.00",
"rate_type": "fixed",
"is_activation_required": true,
"datetime_start": "2018-10-11T15:53:54",
"datetime_end": "2018-11-09T15:53:54"
}
],
"_meta": {
"count": 3,
"limit": 1,
"offset": 0
}
}
Описание полей ответа API-сервера
Название | Описание |
---|---|
id | Идентификатор акции |
campaign_id | Идентификатор партнерской программы |
campaign_name | Наименование партнерской программы |
currency | Код валюты (ISO 4217) |
name | Наименование акции |
rate | Ставка |
datetime_start | Дата и время начала акции |
datetime_end | Дата и время завершения акции |
rate_type | Тип ставки
|
description | Условия акции |
image | Ссылка на изображение |
disabled | Деактивированная акция
|
is_activation_required | Требует ли активации(согласия на участие) со стороны пользователя
|
Получение данных офлайн-чека
Параметры
HTTP метод | Права доступа | URL | Параметры | Примечание |
---|---|---|---|---|
GET | offline_receipts | https://api.admitad.com/ |
Список параметров для запроса | Возвращает информацию о чеке |
- * Возвращает результат в формате JSON.
Список параметров для запроса
Название | Тип | Допустимые значения |
---|---|---|
website_id | integer | Список площадок веб-мастера |
id | string | Список идентификаторов чеков |
datetime_created_from | datetime | Дата и время оплаты чека (%d.%m.%Y %H:%M) |
datetime_created_to | datetime | Дата и время оплаты чека (%d.%m.%Y %H:%M) |
datetime_updated_from | datetime | Дата и время последнего обновления чека (%d.%m.%Y %H:%M) |
datetime_updated_to | datetime | Дата и время последнего обновления чека (%d.%m.%Y %H:%M) |
limit | integer | Параметры limit, offset |
offset | integer | Параметры limit, offset |
purchaser_id | string | Уникальный идентификатор покупателя в системе веб-мастера |
Пример использования
Пример запроса с использованием утилиты curl:
curl -L -H 'Authorization: Bearer access_token' -X GET
'https://api.admitad.com/offline_receipts/?website_id=1&id=5b509f0c47b41317d0829ade&id=4a509f0c47b48362d0829ada''
Пример ответа API-сервера в формате JSON:
{
"results": [
{
"id": "5b509f0c47b41317d0829ade",
"website_id": 1,
"purchaser_id": 2341,
"status": "receipt_info_found",
"payment_ids": [
125342,
2345254
],
"retail_place_address": "",
"user": "",
"total_sum": "2915.00",
"datetime_created": "2018-12-12T00:00:00",
"datetime_updated": "2018-12-12T13:12:00",
"offline_sales_ids": [
31233,
21233
],
"not_activated_offline_sales_ids": [42],
"items": [
{
"sum": "1915.00",
"quantity": "1.00",
"offline_sales_ids": [
31233
],
"price": "1915.00",
"name": "",
},
{
"sum": "1915.00",
"quantity": "1.00",
"offline_sales_ids": [
21233
],
"price": "1915.00",
"name": "",
}
]
"FNS_data": "{\"items\":[{\"paymentType\":4,\"name\":\"qqqq\",\"productType\":1,\"sum\":100,\"price\":100,\"ndsSum\":0,\"nds\":6,\"quantity\":1}],\"userInn\":\"507303885648\",\"operationType\":1,\"dateTime\":\"2018-07-02T21:39:00\"}",
},
{
"id": "4a509f0c47b48362d0829ada",
"website_id": 1,
"purchaser_id": 2342,
"status": "receipt_info_found",
"payment_ids": [
4345254,
]
"retail_place_address": ""
"user": "",
"total_sum": "351918.00",
"datetime_created": "2018-11-12T00:00:00",
"datetime_updated": "2018-12-12T12:15:00",
"offline_sales_ids": [
11233,
],
"not_activated_offline_sales_ids": [],
"items": [
{
"sum": "1915.00",
"quantity": "1.00",
"offline_sales_ids": [
11233
],
"price": "1915.00",
"name": "",
}
]
"FNS_data": "{\"items\":[{\"paymentType\":4,\"name\":\"qqqq\",\"productType\":1,\"sum\":100,\"price\":100,\"ndsSum\":0,\"nds\":6,\"quantity\":1}],\"userInn\":\"507303885648\",\"operationType\":1,\"dateTime\":\"2018-07-02T21:29:00\"}",
},
],
"_meta": {
"count": 2,
"limit": 20,
"offset": 0
}
}
Описание полей ответа API-сервера
Описание полей чека
Название | Описание |
---|---|
id | Идентификатор чека |
website_id | Идентификатор площадки |
purchaser_id | Уникальный идентификатор покупателя в системе веб-мастера |
status | Статус offline чека.
|
payment_ids | Идентификаторы действий (платёжек) сгенерированных при матчинге акций с чека (Статистика по действиям) |
retail_place_address | Адрес магазина |
user | Наименование организации, выдавшей чек |
total_sum | Итоговая сумма расчета |
datetime_created | Дата и время выдачи чека |
datetime_updated | Дата и время последнего изменения данных о чеке |
offline_sales_ids |
Список идетнтификаторов акций которые сработали на чек |
items | Список товаров в чеке |
FNS_data | Данные ФНС (схема нестабильна) |
not_activated_offline_sales_ids | Список идентификаторов акций, которые не сработали, так как не были активированы |
Описание полей товаров чека
>
Название | Описание |
---|---|
sum | Стоимость |
quantity | Количество |
offline_sales_ids | Идентификаторы акций которые сработали на товар |
price | Цена за единицу |
name | Наименование товара |
Описание полей FNS_data (схема нестабильна)
Название | Описание |
---|---|
dateTime | Дата и время выдачи чека |
fiscalDocumentNumber | Номер фискального документа |
fiscalDriveNumber | Номер фискального накопителя |
fiscalSign | Номер фискального признака |
operationType | Признак расчета 1 — приход, 2 — возврат прихода, 3 — расход, 4 — возврат расхода |
totalSum | Итоговая сумма расчета |
cashTotalSum | Сумма расчета наличными |
ecashTotalSum | Сумма расчета безналичным |
nds18 | Сумма НДС по ставке 18% |
nds10 | Сумма НДС по ставке 10% |
ndsNo | Стоимость по ставке 0% НДС |
operator | Кассир |
shiftNumber | Номер смены |
requestNumber | Номер чека |
retailPlaceAddress | Адрес магазина |
user | Наименование организации, выдавшей чек |
userInn | ИНН организации, выдавшей чек |
ofdId | ID Оператора Фискальных Данных |
items | Список товаров |
Создание офлайн-чека
Параметры
HTTP метод | Права доступа | URL | Параметры | Примечание |
---|---|---|---|---|
POST | manage_offline_receipts | https://api.admitad.com/ |
Список параметров для запроса | Возвращает созданный чек*. |
- * Возвращает результат в формате JSON.
Список параметров для запроса
Название | Тип | Обязательный | Ограничения параметров | Примечание, допустимые значения |
---|---|---|---|---|
website_id | integer | ✔ | Список площадок веб-мастера | |
purchaser_id | string | ✔ | Максимальная длина 50 символов | ID покупателя в системе веб-мастера |
qr_code | string | ✔ | urlencoded QR code data |
Пример использования
Пример запроса с использованием утилиты curl:
curl -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/offline_receipts/create/ \
-F 'website_id=1' \
-F 'purchaser_id=2341' \
-F 'qr_code=t%3D20180702T2129%26s%3D260.19%26fn%3D9287440300060728%26i%3D224%26fp%3D2737913366%26n%3D1'
Пример ответа API-сервера в формате JSON:
{
"id": "5b509f0c47b41317d0829ade",
"website_id": 1,
"purchaser_id": 2341,
"status": "new",
"payment_ids": [],
"FNS_data": "",
}
Пример ответа API-сервера при возникновении ошибки:
{
"error": "QR-code already registered.",
"status_code": 400
}
Описание полей ответа API-сервера
Название | Описание |
---|---|
id | Идентификатор чека |
website_id | Идентификатор площадки |
purchaser_id | Уникальный идентификатор покупателя в системе веб-мастера |
status | Статус offline чека |
payment_ids |
Идентификаторы действий |
FNS_data | Данные ФНС |
Список возможных ошибок
Ошибка | Причина |
---|---|
Invalid params | Не переданы все обязательные параметры: website_id, purchaser_id, qr_code |
No programs with offline sales are connected |
Площадка не работает с офлайн-акциями |
Invalid QR code | Невалидный параметр qr_code |
QR-code already registered | QR-код присылается повторно |
Активация офлайн-акции для пользователя
Параметры
HTTP метод | Права доступа | URL | Параметры | Примечание |
---|---|---|---|---|
POST | offline_sales | https://api.admitad.com/ |
Список параметров для запроса | Активирует акцию для пользователя*. |
- * Возвращает результат в формате JSON.
Список параметров для запроса
Название | Тип | Допустимые значения |
---|---|---|
purchaser_id | string | ID пользователя в системе веб-мастера |
website_id | integer | ID сайта/площадки |
sale_id | integer | ID акции |
activated_at | datetime | %d.%m.%Y %H:%M:%S |
Пример использования
Пример запроса с использованием утилиты curl:
curl -L -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/offline_sale_activations/ \
-F 'purchaser_id=123abc' \
-F 'website_id=13' \
-F 'sale_id=14' \
-F 'activated_at=02.23.2019 00:00:00'
Пример ответа API-сервера в формате JSON:
{
"purchaser_id": "123abc",
"website_id": 13,
"sale_id": 14,
"activated_at": "2019-02-23 00:00:00"
}
Описание полей ответа API-сервера
Название | Описание |
---|---|
purchaser_id | ID пользователя в системе веб-мастера |
website_id | ID сайта/площадки |
sale_id | ID акции |
activated_at | Дата и время активации |