Skip to main content
GET
Stock snapshot (JSON, CSV, or Excel)

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

start_date
string
required

Start date in Y-m-d H:i:s format

Example:

"2025-01-01 00:00:00"

end_date
string
required

End date in Y-m-d H:i:s format, must be >= start_date

Example:

"2025-01-31 23:59:59"

warehouse_id
integer

Optional warehouse scope. Products with no stock in that warehouse are excluded.

sku
string

Filter by product SKU. Supports bracket operators such as sku[eq]=ABC and comma-separated sku[in]=ABC,DEF.

sku_prefix
string

Internal SKU starts-with filter, for example sku_prefix=STYLE-RED-. Useful for pulling a style/size family without substring matches.

id
integer

Filter by product ID. Supports bracket operators such as id[in]=1,2,3.

name
string

Filter by product name. Supports bracket operators such as name[contains]=shirt.

category.id
integer

Filter by product category ID.

sub_category.id
integer

Filter by product subcategory ID.

per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
page
integer
default:1

Page number for pagination

Required range: x >= 1
dateBasis
enum<string>
default:order_date

Which date the received quantities and values are bucketed by: the purchase order's order_date (default) or the receiving report's received_date.

Available options:
order_date,
received_date
export
enum<string>

When set to excel or csv, returns a file download instead of JSON.

Available options:
excel,
csv
columns
string

JSON string of export column configuration (when exporting).

Response

Paginated snapshot rows (JSON), or a CSV / Excel file download when export=csv or export=excel is supplied.

data
object[]
meta
object