Search gift cards

GET

/v1/gift-card/search

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'

• Production

Error codes: 404 — object not found; 401, 403, 429, 500 — shared by all methods. Body formats and semantics: Response codes and errors.

Authorizations

• BearerAuth

Parameters

Query Parameters

code

string

Card barcode

status_list

Array<string>

Status: NEW, ACTIVE, USED, CLOSED, EXPIRED

page

integer format: int32

Page number

Example

2

limit

integer format: int32

Page size

Example

10

types

string

Card type: CERTIFICATE or VOUCHER

Example

CERTIFICATE

use_type

string

Usage type: SINGLE or MULTIPLE

Example

SINGLE

from_created_at

string

Start of the creation period

Example

01.12.2024

to_created_at

string

End of the creation period

Example

31.12.2024

from_expire_at

string

Start of the expiry period

Example

01.12.2024

to_expire_at

string

End of the expiry period

Example

31.12.2024

from_sold_at

string

Start of the sale period

Example

01.12.2024

to_sold_at

string

End of the sale period

Example

31.12.2024

from_used_at

string

Start of the usage period

Example

01.12.2024

to_used_at

string

End of the usage period

Example

31.12.2024

show_stats

string

Add statistics to the response

Example

true

from

string

Example

190

Header Parameters

platform-id

string

default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platform identifier. A static value is used for integrations.

Responses

200

Successful response

Media typeapplication/json

object

cards

Card fields: 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

Array<object>

object

sold_at

string

sale_order_number

string

last_used_at

string

last_use_order_number

string

left_amount

number

with_nominal

boolean

id

integer

gift_card_type

string

code

string

amount

number

sale_order_id

string

seller_id

string

activated_at

string

expire_type

string

expire_period

string

expired_at

string

status

string

created_at

string

deleted_at

integer

user_id

string

use_type

string

last_use_date

string

list_id

integer

error_msg

string

company_id

string

stats

Summary indicators

object

key

additional properties

any

total

Total count

integer format: int32

Example^generated

{
  "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
}