GET
List items
Company space For: Manager, Cashier and seller, Stock keeper, Buyer · Permission: inventory_items.list Conditions
  • Only items that have a stock record are listed: items created untracked never appear, while an item whose tracking was switched off keeps its stock record and still appears.
  • Product variants of the organization and bundles of the current company (and organization) are listed; bundles of other companies are hidden.
Part of Create products and variants.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer

Number of items per page.

Required range: 1 <= x <= 100
cursor
string

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string>

Field the list is sorted by.

Available options:
id,
status,
created_at,
updated_at
sort_order
enum<string>

asc for ascending order, desc for descending order.

Available options:
asc,
desc
title
string

Keeps variants whose product title, option value or option name contains this text, and bundles whose title contains it (case-sensitive LIKE).

sku
string

Keeps items having a unit of sale whose SKU contains this text.

status
string

Keeps items in this status: active, draft or archived.

subject_type
string

Keeps one kind of item: product_variant for product variants or bundle for bundles.

is_tracked
enum<string>

Keeps tracked items (true or 1) or untracked items (false or 0). Omit it to return both.

Available options:
true,
false,
1,
0
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: vat_rate_id, tax_configuration_mode, id, title, image_url, subject_type, subject_id, status, is_tracked, is_taxable, options, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: vat_rate, taxes, units, units.uomUnit, units.prices, units.stockable.

Response

Resource.

data
StockableListResource · object[]
required

Items of this page.

meta
object
required

Pagination details.