Skip to content
BILLZ for developers

Imports

GET
/v1/import-report-table
curl --request GET \
  --url 'https://api-admin.billz.ai/v1/import-report-table?start_date=2026-08-01&end_date=2026-08-31&shop_ids=fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6%2C92302dfb-fa33-4e6a-8d19-87214852b25d&import_type=import&page=1&limit=10' \
  --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

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
start_date
string format: date
Example
2026-08-01

Empty → today; format YYYY-MM-DD, without time

end_date
string format: date
Example
2026-08-31

Empty → start_date; always +24h; format YYYY-MM-DD, without time

shop_ids
required
Array<string>

Each element must be a UUID, otherwise 400 ‘Wrong shopID’

Example
[
  "fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6",
  "92302dfb-fa33-4e6a-8d19-87214852b25d"
]
import_type
string

Only ‘import’, ‘supplier_order’ and an empty string are allowed; otherwise → 400

Example
import
page
integer format: int32
default: 1
Example
1
limit
integer format: int32
default: 10
Example
10

Header Parameters

Section titled “Header Parameters”
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platform identifier. A static value is used for integrations.

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
rows
Array<object>
object
shop_id
string
shop_name
string
external_import_id
integer
external_supplier_order_id
integer
import_name
string
supplier_name
string
import_type
string
is_import
boolean
is_supplier_order
boolean
type
string
date
string
imported_qty
integer
imported_retail_sum
number
imported_supply_sum
number
supplier_order_qty
integer
supplier_order_retail_sum
number
supplier_order_supply_sum
number
sold_qty
number
sold_retail_sum
number
sold_supply_sum
number
sold_sale_sum
number
written_off_qty
integer
written_off_retail_sum
number
written_off_supply_sum
number
left_qty
number
left_retail_sum
number
left_supply_sum
number
transfer_arrived_qty
integer
transfer_arrived_retail_price
number
transfer_arrived_supply_sum
number
transfer_finished_qty
integer
transfer_finished_retail_sum
number
transfer_finished_supply_sum
number
returned
number
returned_retail_sum
number
returned_supply_sum
number
returned_sale_sum
number
repricing_qty
integer
repricing_retail_sum
number
repricing_supply_sum
number
return_supplier_order_qty
integer
return_supplier_order_retail_sum
number
return_supplier_order_supply_sum
number
outcome
integer
product_id
string
import_id
string
supplier_order_id
string
product_name
string
product_base_name
string
product_sku
string
product_barcode
string
is_archived
boolean
product_brand_id
string
product_brand_name
string
product_categories
Array<object>
object
categories_path
Array<string>
level_1
Array<string>
level_2
Array<string>
level_3
Array<string>
level_4
Array<string>
level_5
Array<string>
product_measurement_unit_id
string
product_measurement_unit_name
string
product_measurement_unit_short_name
string
product_attributes
Array<object>
object
product_custom_fields
Array<object>
object
count
integer format: int32
Examplegenerated
{
  "rows": [
    {
      "shop_id": "example",
      "shop_name": "example",
      "external_import_id": 1,
      "external_supplier_order_id": 1,
      "import_name": "example",
      "supplier_name": "example",
      "import_type": "example",
      "is_import": true,
      "is_supplier_order": true,
      "type": "example",
      "date": "example",
      "imported_qty": 1,
      "imported_retail_sum": 1,
      "imported_supply_sum": 1,
      "supplier_order_qty": 1,
      "supplier_order_retail_sum": 1,
      "supplier_order_supply_sum": 1,
      "sold_qty": 1,
      "sold_retail_sum": 1,
      "sold_supply_sum": 1,
      "sold_sale_sum": 1,
      "written_off_qty": 1,
      "written_off_retail_sum": 1,
      "written_off_supply_sum": 1,
      "left_qty": 1,
      "left_retail_sum": 1,
      "left_supply_sum": 1,
      "transfer_arrived_qty": 1,
      "transfer_arrived_retail_price": 1,
      "transfer_arrived_supply_sum": 1,
      "transfer_finished_qty": 1,
      "transfer_finished_retail_sum": 1,
      "transfer_finished_supply_sum": 1,
      "returned": 1,
      "returned_retail_sum": 1,
      "returned_supply_sum": 1,
      "returned_sale_sum": 1,
      "repricing_qty": 1,
      "repricing_retail_sum": 1,
      "repricing_supply_sum": 1,
      "return_supplier_order_qty": 1,
      "return_supplier_order_retail_sum": 1,
      "return_supplier_order_supply_sum": 1,
      "outcome": 1,
      "product_id": "example",
      "import_id": "example",
      "supplier_order_id": "example",
      "product_name": "example",
      "product_base_name": "example",
      "product_sku": "example",
      "product_barcode": "example",
      "is_archived": true,
      "product_brand_id": "example",
      "product_brand_name": "example",
      "product_categories": [
        {}
      ],
      "categories_path": [
        "example"
      ],
      "level_1": [
        "example"
      ],
      "level_2": [
        "example"
      ],
      "level_3": [
        "example"
      ],
      "level_4": [
        "example"
      ],
      "level_5": [
        "example"
      ],
      "product_measurement_unit_id": "example",
      "product_measurement_unit_name": "example",
      "product_measurement_unit_short_name": "example",
      "product_attributes": [
        {}
      ],
      "product_custom_fields": [
        {}
      ]
    }
  ],
  "count": 1
}