Skip to main content
GET
List

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

merchantId
string

Filter items by merchant organization id

Pattern: ^org_[a-zA-Z0-9]+$
catalogId
string

Filter items by the product they are filed under Unique identifier for a product

Pattern: ^prod_[a-zA-Z0-9]+$
provider
string

Provider whose external code to resolve (e.g. salesforce, netsuite). Must be supplied together with externalId.

externalId
string

Resolve every live Item mapped to this (provider, externalId) — the canonical primary plus any non-primary aliases. The primary Item is returned first and is identifiable by its matching reference's isPrimary: true. Empty list on no match. Must be supplied together with provider.

limit
integer
default:50

Maximum items to return. In resolution mode (provider+externalId supplied) pagination is over the de-duplicated resolved Item set, primary Item first.

Required range: 1 <= x <= 100
offset
integer
default:0

Zero-based offset for pagination. In resolution mode this paginates the de-duplicated resolved Item set.

Required range: x >= 0
includeArchived
boolean
default:false

Include archived items in the results. By default, archived items are omitted. This is ignored when resolving by provider and externalId, which always returns the matching item regardless of archived status.

Response

List of items

data
object[]
required
pagination
object
required

Offset-based pagination response.