Kontentga o'tish
Dasturchilar uchun BILLZ

Mahsulot qo'shish

POST
/v2/transfer/{id}/add
curl --request POST \
  --url 'https://api-admin.billz.ai/v2/transfer/example/add?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 '{ "arrival_shop_id": "92302dfb-fa33-4e6a-8d19-87214852b25d", "departure_shop_id": "fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6", "product_id": "e5669ce0-3bb9-4330-b139-814843b6709f", "transfer_measurement_value": 1, "is_scan": false }'

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.

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

“Authorizations” bo'limi

Parameters

“Parameters” bo'limi

Path Parameters

“Path Parameters” bo'limi
id
required
string

Yo’ldan olinadi

Header Parameters

“Header Parameters” bo'limi
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

“Query Parameters” bo'limi
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 Bodyrequired

“Request Bodyrequired” bo'limi
Media typeapplication/json
object
product_id
required
string
departure_shop_id
required
string
arrival_shop_id
required
string
transfer_measurement_value
required

Yakuniy miqdor; qayta yuborilganda qiymat almashtiriladi

number format: double
is_scan
boolean
barcode

Shtrix-kod

string
id

Server tomonidan generatsiya qilinadi

string
company_id
string
Example
{
  "arrival_shop_id": "92302dfb-fa33-4e6a-8d19-87214852b25d",
  "departure_shop_id": "fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6",
  "product_id": "e5669ce0-3bb9-4330-b139-814843b6709f",
  "transfer_measurement_value": 1,
  "is_scan": false
}

Responses

“Responses” bo'limi

200

“200” bo'limi

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

Media typeapplication/json
One of:

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