Skip to main content
GET
List Parent Products

Authorizations

Authorization
string
header
required

A brand-scoped or global amb_sk_... API key.

Path Parameters

brand
string
required

Brand slug authorized by this API key.

Example:

"acme"

Query Parameters

cursor
string

Opaque nextCursor from the same collection and filters. Omit on the first request.

limit
integer
default:25
Required range: 1 <= x <= 100
code
string

Exact, case-sensitive Parent Product code. Example: TEE-001.

Required string length: 1 - 255
Example:

"TEE-001"

status
string

Exact product workflow status.

Required string length: 1 - 255
categoryId
string

Category ID from /categories.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
q
string

Case-insensitive literal substring of product name or code. Percent and underscore are ordinary characters.

Required string length: 1 - 255
Example:

"cotton"

Response

One page. totalItems counts the full filtered set; nextCursor null means exhausted.

items
object[]
required
nextCursor
string | null
required
totalItems
integer
required
Required range: 0 <= x <= 9007199254740991