Поиск подарочных карт
const url = 'https://api-admin.billz.ai/v1/gift-card/search?page=2&limit=10&types=CERTIFICATE&use_type=SINGLE&from_created_at=01.12.2024&to_created_at=31.12.2024&from_expire_at=01.12.2024&to_expire_at=31.12.2024&from_sold_at=01.12.2024&to_sold_at=31.12.2024&from_used_at=01.12.2024&to_used_at=31.12.2024&show_stats=true&from=190';const options = { method: 'GET', headers: { 'platform-id': '7d4a4c38-dd84-4902-b744-0488b80a4c01', Authorization: 'Bearer <token>' }};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api-admin.billz.ai/v1/gift-card/search?page=2&limit=10&types=CERTIFICATE&use_type=SINGLE&from_created_at=01.12.2024&to_created_at=31.12.2024&from_expire_at=01.12.2024&to_expire_at=31.12.2024&from_sold_at=01.12.2024&to_sold_at=31.12.2024&from_used_at=01.12.2024&to_used_at=31.12.2024&show_stats=true&from=190' \ --header 'Authorization: Bearer <token>' \ --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'Коды ошибок: 404 — объект не найден; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.
Authorizations
Заголовок раздела «Authorizations»Parameters
Заголовок раздела «Parameters»Query Parameters
Заголовок раздела «Query Parameters»Штрихкод карты
Статус: NEW, ACTIVE, USED, CLOSED, EXPIRED
Номер страницы
Example
2Размер страницы
Example
10Тип карты: CERTIFICATE или VOUCHER
Example
CERTIFICATEТип использования: SINGLE или MULTIPLE
Example
SINGLEНачало периода создания
Example
01.12.2024Конец периода создания
Example
31.12.2024Начало периода истечения срока
Example
01.12.2024Конец периода истечения срока
Example
31.12.2024Начало периода продажи
Example
01.12.2024Конец периода продажи
Example
31.12.2024Начало периода использования
Example
01.12.2024Конец периода использования
Example
31.12.2024Добавить в ответ статистику
Example
trueExample
190Header Parameters
Заголовок раздела «Header Parameters»Идентификатор платформы. Для интеграций используется статичное значение.
Responses
Заголовок раздела «Responses»Успешный ответ
object
Поля карты: id, gift_card_type, code, amount, sale_order_id, seller_id, activated_at, expire_type, expire_period, expired_at, status, created_at, deleted_at, user_id, use_type, last_use_date, list_id, error_msg
object
Сводные показатели
object
Общее количество
Examplegenerated
{ "cards": [ { "sold_at": "example", "sale_order_number": "example", "last_used_at": "example", "last_use_order_number": "example", "left_amount": 1, "with_nominal": true, "id": 1, "gift_card_type": "example", "code": "example", "amount": 1, "sale_order_id": "example", "seller_id": "example", "activated_at": "example", "expire_type": "example", "expire_period": "example", "expired_at": "example", "status": "example", "created_at": "example", "deleted_at": 1, "user_id": "example", "use_type": "example", "last_use_date": "example", "list_id": 1, "error_msg": "example", "company_id": "example" } ], "stats": {}, "total": 1}