List of orders

GET

/v2/supplier-order

const 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';
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/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'

Error codes: 400 — input validation error; 404 — object not found; 401, 403, 429, 500 — shared by all methods. Body formats and semantics: Response codes and errors.

Authorizations

BearerAuth

Parameters

Query Parameters

page

integer format: int32

default: 1

Example

limit

integer format: int32

default: 10

Example

search

string

supplier_ids

Array<string>

CSV

payment_status

string

Paid|not_paid|partially_paid

status_id

string

A single status UUID (not an array)

shop_ids

Array<string>

CSV

start_date

string

end_date

string

start_payment_date

string

from_supply_price

number format: double

Non-numeric -> 400

to_supply_price

number format: double

from_retail_price

number format: double

to_retail_price

number format: double

settlement_type

string

Allowed values: commission consegnation realization

Filter by type of settlement with the supplier: commission, consegnation or realization.

from_measurement_value

number format: double

to_measurement_value

number format: double

type

string

accept_start_date

string

accept_end_date

string

Header Parameters

platform-id

string

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

Platform identifier. A static value is used for integrations.

Responses

200

Successful response

application/json

object

count

integer format: int32

supplier_orders

Array<object>

object

string

name

string

external_id

integer format: int64

company_id

string

shop_id

string

shop

object

string

name

string

supplier_id

string

supplier

object

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

string

name

string

accepted_by

object

string

name

string

sale_progress

number format: double

processed_supply_price

number format: double

invoice_number

integer format: int64

payment_date

string

settlement_type

Type of settlement with the supplier: commission — commission, consegnation — consignment, realization — realization; an empty string means the type is not set. Does not affect the debt to the supplier.

string

Allowed values: commission consegnation realization ""

retail_price_change_type

string

is_from_file

boolean

items

Absent from the response if the value is empty

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

Total count

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"
    }
  ]
}