Skip to main content
GET
List Core inventory transactions

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

page
integer
default:1

Page number (offset pagination).

Required range: x >= 1
per_page
integer
default:100

Rows per page (max 100).

Required range: 1 <= x <= 100
date[gte]
string<date>

Only transactions on or after this date.

date[lte]
string<date>

Only transactions on or before this date.

warehouse_id[in]
string

Comma-separated warehouse ids to include.

transaction_type[in]
string

Comma-separated transaction types to include.

linked_type
string

Filter by the linked document type (e.g. shipment, fulfillment_order, sales_order, adjustment, picklist).

item_id
integer

Filter by product (RFQ) id.

reference
string

Search by linked document reference / order number.

qty_filter
enum<string>
default:all

Restrict to quantity increases or decreases.

Available options:
all,
increase,
decrease
unit_cost_filter
enum<string>
default:all

Restrict to rows with a non-zero or zero unit cost.

Available options:
all,
gt0,
zero
sort_by
enum<string>
default:date

Sort column.

Available options:
date,
qty,
qty_available,
unit_cost,
total_cost,
linked_order_number
sort_dir
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

Paginated list of Core inventory transactions.

data
object[]
meta
object