Karta yaratish

POST

/v1/gift-card/activate-list

curl --request POST \
  --url 'https://api-admin.billz.ai/v1/gift-card/activate-list?Billz-Response-Channel=HTTP' \
  --header 'Authorization: Bearer <token>' \
  --header 'Billz-Response-Channel: HTTP' \
  --header 'Content-Type: application/json' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01' \
  --data '{ "id": 0, "is_activated": false, "gift_cards": [ { "code": "1000000001", "amount": 10000, "expire_period": "31.12.2024" } ], "card_type": "CERTIFICATE", "expire_type": "ABSOLUTE", "use_type": "SINGLE" }'

• Production

Asinxron metod. Natijani HTTP orqali sinxron olish uchun Billz-Response-Channel: HTTP sarlavhasini yuboring — aks holda javob 200 {"message": "<correlation_id>"} bo’ladi. Maksimal kutish vaqti — 600 soniya, so’ngra error.code = TIMEOUT bilan 408.

Kartalar ro’yxati BILLZ interfeysida yaratiladi (Marketing → Sovg’a kartalari); API da ro’yxat yaratish uchun alohida metod yo’q. id — allaqachon yaratilgan ro’yxat identifikatori, metod undagi kartalarni faollashtiradi.

Xato kodlari: 400 — kiruvchi ma’lumotlar validatsiya xatosi; 404 — obyekt topilmadi; 408 — asinxron javobni kutish taym-auti; 401, 403, 429, 500 — barcha metodlar uchun umumiy. Tana formatlari va semantikasi: Javob kodlari va xatolar.

Authorizations

• BearerAuth

Parameters

Header Parameters

platform-id

string

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

Platforma identifikatori. Integratsiyalar uchun statik qiymat ishlatiladi.

Billz-Response-Channel

string

Allowed values: HTTP

HTTP — hodisani qayta ishlash natijasini kutib, uni HTTP javobida qaytarish. Sarlavhasiz metod faqat e’lon qilingan hodisaning correlation_id sini qaytaradi.

Query Parameters

Billz-Response-Channel

string

Allowed values: HTTP

Billz-Response-Channel sarlavhasi bilan bir xil — o’z sarlavhasini yubora olmaydigan mijozlar uchun. Ikkalasi ham uzatilsa, sarlavha amal qiladi.

Request Body^required

Media typeapplication/json

object

id

Mavjud kartalar ro’yxati identifikatori

integer format: int32

0

is_activated

Oldindan faollashtirilgan karta yaratish (faqat VOUCHER uchun)

boolean

gift_cards

Kartalar ro’yxati

Array<object>

object

code

Karta kodi

string

amount

Nominal

number

expire_period

Amal qilish muddati; expire_type ga muvofiq talqin qilinadi

card_type

CERTIFICATE | VOUCHER

string

expire_type

ABSOLUTE yoki RELATIVE

string

use_type

SINGLE | MULTIPLE

string

company_id

string

session_id

string

user

string

Example

{
  "id": 0,
  "is_activated": false,
  "gift_cards": [
    {
      "code": "1000000001",
      "amount": 10000,
      "expire_period": "31.12.2024"
    }
  ],
  "card_type": "CERTIFICATE",
  "expire_type": "ABSOLUTE",
  "use_type": "SINGLE"
}

Responses

200

Muvaffaqiyat. Billz-Response-Channel: HTTP sarlavhasi bilan — asinxron javob konverti, usiz — {"message": "<correlation_id>"}.

Media typeapplication/json

One of:

object

Asinxron javob konverti. Billz-Response-Channel: HTTP sarlavhasi uzatilganda qaytariladi. So’rovning yakuniy HTTP kodi status_code maydonidan olinadi.

object

session_id

Mijoz sessiyasi identifikatori

string format: uuid

status_code

Hodisani qayta ishlash holati (u yakuniy HTTP javob kodi hamdir)

integer

error

object

code

Xato kodi, xato bo’lmasa bo’sh satr

string

message

Xato matni, xato bo’lmasa — bo’sh satr

string

correlation_id

So’rov identifikatori, e’lon qilingan hodisa ID si bilan mos keladi

string format: uuid

topic

Javob hodisasining turi, masalan <event_type>.success

string

data

Operatsiya natijasi, agar metod uni qaytarsa

object

object

Billz-Response-Channel sarlavhasisiz asinxron metod javobi — hodisa e’lon qilindi.

object

message

E’lon qilingan hodisaning correlation_id si

string format: uuid

object

object

session_id

Ulanish sessiyasining ichki id si

string

status_code

Hodisani qayta ishlash natijasi kodi (muvaffaqiyatda 200)

integer format: int32

id

Javob xabari id si

string

company_id

Kompaniya id si

string

error

Ichki xato kodi/xabari

object

code

string

message

string

data

Javobning foydali yuki

integer format: int32

correlation_id

So’rov identifikatori

string

topic

Javob hodisasining turi, masalan <event_type>.success

string

Example^generated

{
  "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status_code": 1,
  "error": {
    "code": "example",
    "message": "example"
  },
  "correlation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "topic": "example",
  "data": {}
}