Skip to content
BILLZ for developers

List of products in the transfer

GET
/v2/transfer-items/{id}
curl --request GET \
  --url 'https://api-admin.billz.ai/v2/transfer-items/example?page=1&limit=5&from_price=0&to_price=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

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Query Parameters

Section titled “Query Parameters”
page
integer format: int32
default: 1

<= 1000, otherwise 400

Example
1
limit
integer format: int32
default: 10

<= 1000, otherwise 400

Example
5
search
string

Search; no more than 100 characters

barcode
string

Barcode; at most 100 characters

category_ids
Array<string>

Categories, comma-separated; at most 100 elements

from_price
integer format: int64
0

Integer; a fractional value — 400

to_price
integer format: int64
0

Integer; a fractional value — 400

sort_field
Array<string>

Sort field

sort_direction
Array<string>

asc or desc; applied only together with sort_field

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
items
Array<object>
object
id
string
transfer_id
string
product_id
string
transfer_measurement_value
number format: double
updated_at
string
updated_at_int
integer format: int64
arrived_measurement_value
number format: double
product
object
id
string
parent_id
string
company_id
string
categories
Array<string>
name
string
sku
string
barcode
string
category_name
string
departure_shop_measurement_value
object
small_left_measurement_value
number
has_trigger
boolean
shop_id
string
total_measurement_value
number
total_min_supply_price
number
total_max_supply_price
number
total_supply_sum
number
total_active_measurement_value
number
total_active_min_supply_price
number
total_active_max_supply_price
number
total_active_supply_sum
number
total_inactive_measurement_value
number
total_inactive_min_supply_price
number
total_inactive_max_supply_price
number
total_inactive_supply_sum
number
total_sold_measurement_value
number
total_imported_measurement_value
number
total_transfer_arrived_measurement_value
number
total_transfered_measurement_value
number
total_in_transfer_measurement_value
number
total_in_transfer_min_supply_price
number
total_in_transfer_max_supply_price
number
total_in_transfer_supply_sum
number
total_written_off_measurement_value
number
import_started_measurement_value
number
is_small_left
boolean
total_retail_sum
number
total_active_retail_sum
number
total_inactive_retail_sum
number
arrival_shop_measurement_values
object
small_left_measurement_value
number
has_trigger
boolean
shop_id
string
total_measurement_value
number
total_min_supply_price
number
nullable
total_max_supply_price
number
nullable
total_supply_sum
number
total_active_measurement_value
number
total_active_min_supply_price
number
nullable
total_active_max_supply_price
number
nullable
total_active_supply_sum
number
total_inactive_measurement_value
number
total_inactive_min_supply_price
number
nullable
total_inactive_max_supply_price
number
nullable
total_inactive_supply_sum
number
total_sold_measurement_value
number
total_imported_measurement_value
number
total_transfer_arrived_measurement_value
number
total_transfered_measurement_value
number
total_in_transfer_measurement_value
number
total_in_transfer_min_supply_price
number
nullable
total_in_transfer_max_supply_price
number
nullable
total_in_transfer_supply_sum
number
total_written_off_measurement_value
number
import_started_measurement_value
number
is_small_left
boolean
total_retail_sum
number
total_active_retail_sum
number
total_inactive_retail_sum
number
departure_shop_retail_price
number format: double
arrival_shop_retail_price
number format: double
measurement_values
object
total_measurement_value
number
total_active_measurement_value
number
total_inactive_measurement_value
number
supply_price
number format: double
departure_shop_supply_price
number format: double
measurement_unit
object
id
string
name
string
company_id
string
short_name
string
precision
string
is_editable
boolean
is_default
boolean
custom_fields
Array<string>
nullable
base_name
string
product_attributes
Array<string>
additional_barcodes

Additional barcodes

Array<string>
product_info
object
id
string
company_id
string
name
string
sku
string
barcode
string
additional_barcodes
Array<object>
nullable
object
description
string
measurement_values
object
total_measurement_value
number
total_active_measurement_value
number
total_inactive_measurement_value
number
measurement_unit
object
id
string
name
string
company_id
string
short_name
string
precision
string
is_editable
boolean
is_default
boolean
shop_measurement_values
Array<object>
object
small_left_measurement_value
number
has_trigger
boolean
shop_id
string
total_measurement_value
number
total_min_supply_price
number
nullable
total_max_supply_price
number
nullable
total_supply_sum
number
total_active_measurement_value
number
total_active_min_supply_price
number
nullable
total_active_max_supply_price
number
nullable
total_active_supply_sum
number
total_inactive_measurement_value
number
total_inactive_min_supply_price
number
nullable
total_inactive_max_supply_price
number
nullable
total_inactive_supply_sum
number
total_sold_measurement_value
number
total_imported_measurement_value
number
total_transfer_arrived_measurement_value
number
total_transfered_measurement_value
number
total_in_transfer_measurement_value
number
total_in_transfer_min_supply_price
number
nullable
total_in_transfer_max_supply_price
number
nullable
total_in_transfer_supply_sum
number
total_written_off_measurement_value
number
import_started_measurement_value
number
is_small_left
boolean
total_retail_sum
number
total_active_retail_sum
number
total_inactive_retail_sum
number
shop_prices
Array<object>
object
shop_id
string
retail_price
number
retail_currency
string
supply_currency
string
min_supply_price
number
max_supply_price
number
supply_price
number
wholesale_price
number
min_price
number
max_price
number
prices_list
Array<number>
from_supply_price
number
currency_prices
Array<object>
object
currency
string
retail_price
number
min_supply_price
number
max_supply_price
number
supply_price
number
wholesale_price
number
min_price
number
max_price
number
prices_list
Array<number>
promo_price
number
promos
Array<object>
nullable
object
retail_price_created_at
string
supply_price_created_at
string
prices
object
total_supply_price
number
total_retail_price
number
total_active_supply_price
number
total_active_retail_price
number
total_inactive_supply_price
number
total_inactive_retail_price
number
product_type_id
string
created_at
string
updated_at
string
base_name
string
archived_at
string
archived_by
object
id
string
name
string
product_supplier_stock
Array<object>
object
supplier_id
string
supplier_name
string
shop_id
string
measurement_value
number
min_supply_price
number
max_supply_price
number
retail_price
number
wholesale_price
number
product_supply_stock
Array<object>
object
shop_id
string
shop_name
string
measurement_value
number
active_measurement_value
number
inactive_measurement_value
number
supply_price
number
supplier_ids
Array<string>
status
integer
scale_plu
integer
scale_code
integer
is_scalable
boolean
shop_free_prices
Array<object>
object
shop_id
string
sell_with_free_price
boolean
sort
Array<string>
cash_sale
number
count

Number of items

integer format: int32
total_measurement_value

Total quantity

number format: double
total_transfer_value

Total transfer value

number format: double
total_supply_price

Total supply value

number format: double
total_retail_price

Total retail value

number format: double
fields

Table column settings

Array<object>
object
id
string
name
string
sequence_number
integer
is_active
boolean
is_attribute
boolean
is_custom_field
boolean
stocktaking_id

Stocktaking identifier

string
Examplegenerated
{
  "items": [
    {
      "id": "example",
      "transfer_id": "example",
      "product_id": "example",
      "transfer_measurement_value": 1,
      "updated_at": "example",
      "updated_at_int": 1,
      "arrived_measurement_value": 1,
      "product": {
        "id": "example",
        "parent_id": "example",
        "company_id": "example",
        "categories": [
          "example"
        ],
        "name": "example",
        "sku": "example",
        "barcode": "example",
        "category_name": "example",
        "departure_shop_measurement_value": {
          "small_left_measurement_value": 1,
          "has_trigger": true,
          "shop_id": "example",
          "total_measurement_value": 1,
          "total_min_supply_price": 1,
          "total_max_supply_price": 1,
          "total_supply_sum": 1,
          "total_active_measurement_value": 1,
          "total_active_min_supply_price": 1,
          "total_active_max_supply_price": 1,
          "total_active_supply_sum": 1,
          "total_inactive_measurement_value": 1,
          "total_inactive_min_supply_price": 1,
          "total_inactive_max_supply_price": 1,
          "total_inactive_supply_sum": 1,
          "total_sold_measurement_value": 1,
          "total_imported_measurement_value": 1,
          "total_transfer_arrived_measurement_value": 1,
          "total_transfered_measurement_value": 1,
          "total_in_transfer_measurement_value": 1,
          "total_in_transfer_min_supply_price": 1,
          "total_in_transfer_max_supply_price": 1,
          "total_in_transfer_supply_sum": 1,
          "total_written_off_measurement_value": 1,
          "import_started_measurement_value": 1,
          "is_small_left": true,
          "total_retail_sum": 1,
          "total_active_retail_sum": 1,
          "total_inactive_retail_sum": 1
        },
        "arrival_shop_measurement_values": {
          "small_left_measurement_value": 1,
          "has_trigger": true,
          "shop_id": "example",
          "total_measurement_value": 1,
          "total_min_supply_price": 1,
          "total_max_supply_price": 1,
          "total_supply_sum": 1,
          "total_active_measurement_value": 1,
          "total_active_min_supply_price": 1,
          "total_active_max_supply_price": 1,
          "total_active_supply_sum": 1,
          "total_inactive_measurement_value": 1,
          "total_inactive_min_supply_price": 1,
          "total_inactive_max_supply_price": 1,
          "total_inactive_supply_sum": 1,
          "total_sold_measurement_value": 1,
          "total_imported_measurement_value": 1,
          "total_transfer_arrived_measurement_value": 1,
          "total_transfered_measurement_value": 1,
          "total_in_transfer_measurement_value": 1,
          "total_in_transfer_min_supply_price": 1,
          "total_in_transfer_max_supply_price": 1,
          "total_in_transfer_supply_sum": 1,
          "total_written_off_measurement_value": 1,
          "import_started_measurement_value": 1,
          "is_small_left": true,
          "total_retail_sum": 1,
          "total_active_retail_sum": 1,
          "total_inactive_retail_sum": 1
        },
        "departure_shop_retail_price": 1,
        "arrival_shop_retail_price": 1,
        "measurement_values": {
          "total_measurement_value": 1,
          "total_active_measurement_value": 1,
          "total_inactive_measurement_value": 1
        },
        "supply_price": 1,
        "departure_shop_supply_price": 1,
        "measurement_unit": {
          "id": "example",
          "name": "example",
          "company_id": "example",
          "short_name": "example",
          "precision": "example",
          "is_editable": true,
          "is_default": true
        },
        "custom_fields": [
          "example"
        ],
        "base_name": "example",
        "product_attributes": [
          "example"
        ],
        "additional_barcodes": [
          "example"
        ]
      },
      "product_info": {
        "id": "example",
        "company_id": "example",
        "name": "example",
        "sku": "example",
        "barcode": "example",
        "additional_barcodes": [
          {}
        ],
        "description": "example",
        "measurement_values": {
          "total_measurement_value": 1,
          "total_active_measurement_value": 1,
          "total_inactive_measurement_value": 1
        },
        "measurement_unit": {
          "id": "example",
          "name": "example",
          "company_id": "example",
          "short_name": "example",
          "precision": "example",
          "is_editable": true,
          "is_default": true
        },
        "shop_measurement_values": [
          {
            "small_left_measurement_value": 1,
            "has_trigger": true,
            "shop_id": "example",
            "total_measurement_value": 1,
            "total_min_supply_price": 1,
            "total_max_supply_price": 1,
            "total_supply_sum": 1,
            "total_active_measurement_value": 1,
            "total_active_min_supply_price": 1,
            "total_active_max_supply_price": 1,
            "total_active_supply_sum": 1,
            "total_inactive_measurement_value": 1,
            "total_inactive_min_supply_price": 1,
            "total_inactive_max_supply_price": 1,
            "total_inactive_supply_sum": 1,
            "total_sold_measurement_value": 1,
            "total_imported_measurement_value": 1,
            "total_transfer_arrived_measurement_value": 1,
            "total_transfered_measurement_value": 1,
            "total_in_transfer_measurement_value": 1,
            "total_in_transfer_min_supply_price": 1,
            "total_in_transfer_max_supply_price": 1,
            "total_in_transfer_supply_sum": 1,
            "total_written_off_measurement_value": 1,
            "import_started_measurement_value": 1,
            "is_small_left": true,
            "total_retail_sum": 1,
            "total_active_retail_sum": 1,
            "total_inactive_retail_sum": 1
          }
        ],
        "shop_prices": [
          {
            "shop_id": "example",
            "retail_price": 1,
            "retail_currency": "example",
            "supply_currency": "example",
            "min_supply_price": 1,
            "max_supply_price": 1,
            "supply_price": 1,
            "wholesale_price": 1,
            "min_price": 1,
            "max_price": 1,
            "prices_list": [
              1
            ],
            "from_supply_price": 1,
            "currency_prices": [
              {
                "currency": "example",
                "retail_price": 1,
                "min_supply_price": 1,
                "max_supply_price": 1,
                "supply_price": 1,
                "wholesale_price": 1,
                "min_price": 1,
                "max_price": 1,
                "prices_list": [
                  1
                ]
              }
            ],
            "promo_price": 1,
            "promos": [
              {}
            ],
            "retail_price_created_at": "example",
            "supply_price_created_at": "example"
          }
        ],
        "prices": {
          "total_supply_price": 1,
          "total_retail_price": 1,
          "total_active_supply_price": 1,
          "total_active_retail_price": 1,
          "total_inactive_supply_price": 1,
          "total_inactive_retail_price": 1
        },
        "product_type_id": "example",
        "created_at": "example",
        "updated_at": "example",
        "base_name": "example",
        "archived_at": "example",
        "archived_by": {
          "id": "example",
          "name": "example"
        },
        "product_supplier_stock": [
          {
            "supplier_id": "example",
            "supplier_name": "example",
            "shop_id": "example",
            "measurement_value": 1,
            "min_supply_price": 1,
            "max_supply_price": 1,
            "retail_price": 1,
            "wholesale_price": 1
          }
        ],
        "product_supply_stock": [
          {
            "shop_id": "example",
            "shop_name": "example",
            "measurement_value": 1,
            "active_measurement_value": 1,
            "inactive_measurement_value": 1,
            "supply_price": 1,
            "supplier_ids": [
              "example"
            ]
          }
        ],
        "status": 1,
        "scale_plu": 1,
        "scale_code": 1,
        "is_scalable": true,
        "shop_free_prices": [
          {
            "shop_id": "example",
            "sell_with_free_price": true
          }
        ],
        "sort": [
          "example"
        ],
        "cash_sale": 1
      }
    }
  ],
  "count": 1,
  "total_measurement_value": 1,
  "total_transfer_value": 1,
  "total_supply_price": 1,
  "total_retail_price": 1,
  "fields": [
    {
      "id": "example",
      "name": "example",
      "sequence_number": 1,
      "is_active": true,
      "is_attribute": true,
      "is_custom_field": true
    }
  ],
  "stocktaking_id": "example"
}