Перейти к содержимому

Список заказов

GET
/v2/supplier-order
curl --request GET \
--url 'https://api-admin.billz.ai/v2/supplier-order?page=1&limit=10&from_supply_price=0&to_supply_price=0&from_retail_price=0&to_retail_price=0&settlement_type=commission&from_measurement_value=0&to_measurement_value=0' \
--header 'Authorization: Bearer <token>' \
--header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

Коды ошибок: 400 — ошибка валидации входных данных; 404 — объект не найден; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.

page
integer format: int32
default: 1
Example
1
limit
integer format: int32
default: 10
Example
10
search
string

Поиск

supplier_ids
Array<string>

CSV

payment_status
string

Paid|not_paid|partially_paid

status_id
string

Один UUID статуса (не массив)

shop_ids
Array<string>

CSV

start_date
string
end_date
string
start_payment_date
string
from_supply_price
number format: double
0

Нечисловое -> 400

to_supply_price
number format: double
0
from_retail_price
number format: double
0
to_retail_price
number format: double
0
settlement_type
string
Allowed values: commission consegnation realization

Фильтр по типу взаиморасчёта с поставщиком: commission, consegnation или realization.

from_measurement_value
number format: double
0
to_measurement_value
number format: double
0
type
string
accept_start_date
string
accept_end_date
string
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Идентификатор платформы. Для интеграций используется статичное значение.

Успешный ответ

Media typeapplication/json
object
count
integer format: int32
supplier_orders
Array<object>
object
id
string
name
string
external_id
integer format: int64
company_id
string
shop_id
string
shop
object
id
string
name
string
supplier_id
string
supplier
object
id
string
name
string
phone_numbers
Array<string>
nullable
external_id
integer
debt_value
number
balance
number
total_purchase_price
number
total_paid_amount
number
total_purchase_measurement_value
number
total_returned_amount
number
unpaid_count
integer
paid_count
integer
total_order_measurement_value
number
orders_frequency
integer
returned_payments
number
created_at
string
deleted_at
integer
status_id
string
total_price
number format: double
total_supply_price
number format: double
total_retail_price
number format: double
total_paid_amount
number format: double
accepting_date
string
total_measurement_value
number format: double
total_accepted_measurement_value
number format: double
created_by
object
id
string
name
string
accepted_by
object
id
string
name
string
sale_progress
number format: double
processed_supply_price
number format: double
invoice_number
integer format: int64
payment_date
string
settlement_type

Тип взаиморасчёта с поставщиком: commission — комиссия, consegnation — консигнация, realization — реализация; пустая строка — тип не указан. На сумму долга перед поставщиком не влияет.

string
Allowed values: commission consegnation realization ""
retail_price_change_type
string
is_from_file
boolean
items

Отсутствует в ответе, если значение пустое

Array<string>
comment
string
created_at
string
payments
Array<string>
nullable
allowed_shops
string
type
string
returned_supplier_order_id
string
returned_supplier_order_name
string
to_return_amount
number format: double
left_measurement_value
number format: double
returned_measurement_value
number format: double
total_measurement_value_to_return
number format: double
total_returned_amount
number format: double
total_amount_debit
number format: double
returned_payments
number format: double
is_finished
boolean
items_count
integer format: int32
deleted_at
integer format: int64
edit_supplier_id
string
total_quantity

Общее количество

integer format: int64
total_paid_quantity
integer format: int64
total_not_paid_quantity
integer format: int64
total_partially_paid_quantity
integer format: int64
Example
{
"supplier_orders": [
{
"settlement_type": "commission"
}
]
}