GET
List products
Company space For: Manager, Cashier and seller, Stock keeper, Buyer · Permission: products.list Conditions
  • The caller’s company and organization must be resolvable, otherwise the call is refused.
  • Only products of the current organization are listed; the shared catalogue is not filtered by company.
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

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: id, handle, status_counts, type, tags, published_at, title, description, is_tracked, uom_category_id, created_at, updated_at, options, organization_id.

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: variants, variants.vat_rate, variants.taxes, variants.image, variants.inventoryItem, variants.levels, variants.units, images, category, category.vat_rate, category.taxes.

Response

200 - application/json

Resource.

data
ProductResource · object[]
required

Items of this page.

meta
object
required

Pagination details.