Kechiktirilgan sotuvlar ro'yxati / Qoralamalar ro'yxati

GET

/v2/order-notes

const url = 'https://api-admin.billz.ai/v2/order-notes?page=1&limit=5&shop_id=803b542d-51e5-41ea-9124-51f248536286&start_total_price=0&end_total_price=0&order_park_status=active%2Cexpired&shift_id=0&future_time_is_null=false';
const options = {
  method: 'GET',
  headers: {
    'platform-id': '7d4a4c38-dd84-4902-b744-0488b80a4c01',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api-admin.billz.ai/v2/order-notes?page=1&limit=5&shop_id=803b542d-51e5-41ea-9124-51f248536286&start_total_price=0&end_total_price=0&order_park_status=active%2Cexpired&shift_id=0&future_time_is_null=false' \
  --header 'Authorization: Bearer <token>' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

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

Authorizations

BearerAuth

Parameters

Query Parameters

page

integer format: int32

default: 1

Sahifa raqami; raqam bo’lmagan qiymat -> 400

Example

limit

integer format: int32

default: 10

Sahifa hajmi

Example

shop_id

string format: uuid

Do’kon; bo’sh bo’lmagan qiymat UUID bo’lishi shart

Example

803b542d-51e5-41ea-9124-51f248536286

user_id

string format: uuid

Kassir

seller_id

string format: uuid

Sotuvchi

company_payment_type_id

string format: uuid

To’lov turi (birlik son)

start_total_price

number format: double

Chek summasi (dan)

end_total_price

number format: double

Chek summasi (gacha)

order_park_status

Array<string>

Active, expired, completed; bo’sh bo’lsa va future_time_is_null=false — uchala holat ham qo’yiladi

Example

[
  "active",
  "expired"
]

cashbox_id

string format: uuid

Kassa

shift_id

integer format: int64

Smena; shift_id>0 va cashbox_id berilgan bo’lsa, smenaning ochilish/yopilish sanalari bo’yicha filtr qo’llaniladi

search

string

Sotuv id si, mijoz yoki foydalanuvchi bo’yicha qidiruv

start_date

string

Yaratilgan sana (dan boshlab)

end_date

string

Yaratilgan sana (gacha)

order_types

Array<string>

SALE, RETURN, EXCHANGE

future_time_is_null

string

Satr, bool emas: “false” qiymati barcha park-holatlarning qo’yilishini yoqadi

Example

false

stocktaking_shop_id

string

Inventarizatsiya do’koni

last_update

string

Oxirgi yangilanish sanasi bo’yicha filtrlash

Header Parameters

platform-id

string

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

Platforma identifikatori. Integratsiyalar uchun statik qiymat ishlatiladi.

Responses

200

Muvaffaqiyatli javob

application/json

object

count

Yozuvlarning umumiy soni

integer format: int32

orders

Sotuvlar ro’yxati

Array<object>

nullable

object

Sotuv id si

string

parent_id

Asosiy sotuv (qaytarishda)

string

company_id

Kompaniya id si

string

order_number

Sotuv raqami

string

order_status

Sotuv holati

string

order_detail

Tafsilotlar: customer, user, cashbox_name, cashbox_id, cashbox_history_id, shift_id, shop_id, shop, total_price, discount_value, discount_unit, has_discount, total_measurement_value, version_number, comment, created_at, created_at_utc, order_items, order_payments, with_cashback, returned_cashback, loyalty, gift_card_payment, is_authorized, has_certificate, has_voucher, promo_codes, without_cashback, user_has_auth_role, offline_order_validation_status, applied_on_cart, auth_client_cashback_withdrawal, has_payment_token, payment_token, rounding_operations

object

customer

object

user

object

string

name

string

first_name

string

last_name

string

cashbox_name

string

cashbox_id

string

cashbox_history_id

string

shift_id

integer

shop_id

string

shop

object

string

name

string

total_price

number

has_discount

boolean

total_products_measurement_value

number

total_sets_measurement_value

number

total_services_measurement_value

number

total_returned_measurement_value

number

comment

string

created_at

string

created_at_utc

string

with_cashback

number

returned_cashback

number

loyalty_balance_income

number

loyalty_balance_outcome

number

loyalty_payment

integer

not_loyalty_payment

integer

gift_card_payment

integer

is_authorized

boolean

has_certificate

boolean

has_voucher

boolean

promo_codes

Array<string>

nullable

without_cashback

boolean

user_has_auth_role

boolean

offline_order_validation_status

integer

applied_on_cart

boolean

auth_client_cashback_withdrawal

boolean

has_payment_token

boolean

payment_token

string

rounding_operations

Array<object>

nullable

object

order_type

SALE / RETURN / EXCHANGE

string

created_at

Yaratilgan sana

string

deleted_at

O’chirilgan sana (epoch)

integer format: int64

created_at_utc

Yaratilgan sana UTC

string

future_time

Kechiktirilgan sotuv vaqti

string

debt

Qarz

string

nullable

customer_id

Mijoz

string

parent_order_debt

Ota sotuv qarzi

string

nullable

deleted

O’chirilganlik belgisi

boolean

deleted_by_user_id

Kim o’chirgan

string

deleted_by_user_name

O’chirgan shaxsning ismi

string

webkassa_log_qty

Webkassa loglari soni

integer format: int32

epos_log_qty

EPOS loglari soni

integer format: int32

epos_logs

Fiskal loglar

Array<string>

nullable

finished_at

Haqiqiy yakunlanish

string

display_finished_at

Ko’rsatiladigan tugash

string

sold_at

Sotuv sanasi

string

display_sold_at

Ko’rsatiladigan sotuv sanasi

string

display_deleted_at

Ko’rsatiladigan o’chirish sanasi

string

order_debt_payments

Qarz bo’yicha to’lovlar

Array<string>

nullable

park_status

Kechiktirilgan sotuv holati

string

exchange_disabled

Almashtirish taqiqlangan

boolean

total_remaining_debt_in_chain

Zanjir bo’yicha qarz qoldig’i

number format: double

total_remaining_softpos_payment

SoftPOS orqali to’lov qoldig’i

number format: double

updated_at

Yangilanish sanasi

string

has_insurance

Sug’urta bor

boolean

insurance

Sug’urta

string

nullable

is_calculated

boolean

Example^generated

{
  "count": 1,
  "orders": [
    {
      "id": "example",
      "parent_id": "example",
      "company_id": "example",
      "order_number": "example",
      "order_status": "example",
      "order_detail": {
        "customer": {},
        "user": {
          "id": "example",
          "name": "example",
          "first_name": "example",
          "last_name": "example"
        },
        "cashbox_name": "example",
        "cashbox_id": "example",
        "cashbox_history_id": "example",
        "shift_id": 1,
        "shop_id": "example",
        "shop": {
          "id": "example",
          "name": "example"
        },
        "total_price": 1,
        "has_discount": true,
        "total_products_measurement_value": 1,
        "total_sets_measurement_value": 1,
        "total_services_measurement_value": 1,
        "total_returned_measurement_value": 1,
        "comment": "example",
        "created_at": "example",
        "created_at_utc": "example",
        "with_cashback": 1,
        "returned_cashback": 1,
        "loyalty_balance_income": 1,
        "loyalty_balance_outcome": 1,
        "loyalty_payment": 1,
        "not_loyalty_payment": 1,
        "gift_card_payment": 1,
        "is_authorized": true,
        "has_certificate": true,
        "has_voucher": true,
        "promo_codes": [
          "example"
        ],
        "without_cashback": true,
        "user_has_auth_role": true,
        "offline_order_validation_status": 1,
        "applied_on_cart": true,
        "auth_client_cashback_withdrawal": true,
        "has_payment_token": true,
        "payment_token": "example",
        "rounding_operations": [
          {}
        ]
      },
      "order_type": "example",
      "created_at": "example",
      "deleted_at": 1,
      "created_at_utc": "example",
      "future_time": "example",
      "debt": "example",
      "customer_id": "example",
      "parent_order_debt": "example",
      "deleted": true,
      "deleted_by_user_id": "example",
      "deleted_by_user_name": "example",
      "webkassa_log_qty": 1,
      "epos_log_qty": 1,
      "epos_logs": [
        "example"
      ],
      "finished_at": "example",
      "display_finished_at": "example",
      "sold_at": "example",
      "display_sold_at": "example",
      "display_deleted_at": "example",
      "order_debt_payments": [
        "example"
      ],
      "park_status": "example",
      "exchange_disabled": true,
      "total_remaining_debt_in_chain": 1,
      "total_remaining_softpos_payment": 1,
      "updated_at": "example",
      "has_insurance": true,
      "insurance": "example",
      "is_calculated": true
    }
  ]
}

Kechiktirilgan sotuvlar ro'yxati / Qoralamalar ro'yxati

Authorizations

Parameters

Query Parameters

Example

Example

Example

Example

Example

Header Parameters

Responses

200

Examplegenerated

Example^generated