Yaratish

POST

/v2/transfer

curl --request POST \
  --url 'https://api-admin.billz.ai/v2/transfer?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", "name": "Трансфер 2023.05.17 14:47" }'

• 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.

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

departure_shop_id

required

Jo’natuvchi do’kon foydalanuvchiga ochiq bo’lishi kerak, aks holda 400

string

arrival_shop_id

required

string

name

required

string

session_id

string

transfer_items

Pozitsiyalarni yaratish vaqtidayoq uzatish mumkin

Array<object>

object

id

Server tomonidan generatsiya qilinadi

string

external_id

Server tomonidan generatsiya qilinadi

integer format: int32

company_id

string

created_by

object

id

string

name

string

Example

{
  "arrival_shop_id": "92302dfb-fa33-4e6a-8d19-87214852b25d",
  "departure_shop_id": "fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6",
  "name": "Трансфер 2023.05.17 14:47"
}

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

message

Correlation_id, Billz-Response-Channel: HTTP bo’lmaganda

string

status_code

integer format: int32

id

Yaratilgan ko’chirish id si

string

error

object

code

string

message

string

data

integer format: int32

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