Mijozlar bo'yicha xulosa

POST

/v1/customer-general-report-excel

curl --request POST \
  --url 'https://api-admin.billz.ai/v1/customer-general-report-excel?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 '{ "shop_ids": [ "2339a738-a67f-48d2-bb60-8cf4ec54d6cd" ], "start_date": "2026-08-01", "end_date": "2026-08-31", "currency": "UZS", "price_type": 1, "fields": [ "customer_name", "customer_phones", "total_purchase_sum", "total_sale_count" ] }'

• Production

Asinxron metod. Fayl fonda yig’iladi. Billz-Response-Channel: HTTP sarlavhasi majburiy: faqat u bilan javobda tayyor faylga havola keladi, kutish — 100 soniyagacha. Sarlavhasiz javob 200 {"message": "<correlation_id>"} bo’ladi va faylni API orqali olib bo’lmaydi: havola BILLZ interfeysiga bildirishnoma sifatida yuboriladi.

Har bir mijoz bo’yicha xaridlar, qaytarishlar va o’rtacha chek — butun vaqt uchun va tanlangan davr uchun.

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

start_date

Davr boshi, YYYY-MM-DD

string

end_date

Davr oxiri, YYYY-MM-DD

string

shop_ids

Hisobot do’konlari; tokenga ochiq do’konlar ro’yxati bilan kesishtiriladi

Array<string>

currency

Summalar ko’rsatiladigan valyuta

string

price_type

Narx turi: 0 — barchasi, 1 — chakana, 2 — erkin, 3 — ulgurji

integer format: int32

Allowed values: 0 1 2 3

fields

Fayl ustunlari kelish tartibida. fields siz faylda ma’lumotli ustunlar bo’lmaydi; qiymatlar ro’yxati — Hisobotlarni Excel’ga eksport qilish

Array<string>

Example

{
  "shop_ids": [
    "2339a738-a67f-48d2-bb60-8cf4ec54d6cd"
  ],
  "start_date": "2026-08-01",
  "end_date": "2026-08-31",
  "currency": "UZS",
  "price_type": 1,
  "fields": [
    "customer_name",
    "customer_phones",
    "total_purchase_sum",
    "total_sale_count"
  ]
}

Responses

200

Muvaffaqiyat. Billz-Response-Channel: HTTP sarlavhasi bilan — faylga havolali 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

Tayyor faylga havolali asinxron javob konverti.

object

status_code

integer format: int32

error

object

code

string

message

string

correlation_id

string format: uuid

data

object

filename

Kengaytmasiz fayl nomi

string

url

Tayyor faylga havola; unda kengaytma yo’q, mazmuni — .xlsx

string

session_id

string

topic

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