Skip to main content
GET
Get 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"

id
string
required

Stable resource identifier.

Query Parameters

include
string

Related collections to include, separated by commas: documents, images, bomSections, launchWindowDefinitions, tagDefinitions, collectionDefinitions, dimensionValueDefinitions, dimensionDefinitions, optionValueDefinitions, optionDefinitions, categories, colors, materialVariants, materials, productOptions, skus, versions, boms, bomComponents, measurementTables, optionValues, dimensionValues, prices, optionCollections, bomSkus, measurementTableSkus, skuDimensionValues, collections, tags, launchWindows, relations. Use all to request every supported collection. Each collection returns up to includeLimit records (default 25, maximum 100). To read more, add its nextCursor to the returned url. Each distinct collection uses one expansion credit. Your key has up to 62 credits, replenished at 1,000 per hour by default. On 429, wait for Retry-After before retrying. Continuation requests use no expansion credits. See product expansions for examples and rate limits.

Example:

"boms,bomComponents,measurementTables,productOptions,materials"

includeLimit
integer
default:25

Rows per included relationship, default 25. Requires include. Each relationship has its own continuation cursor.

Required range: 1 <= x <= 300

Response

The requested record.

id
string
required
code
string
required
name
string
required
status
string | null
required
description
string | null
required
category
string | null
required
categoryId
string | null
required
variants
object[]
required
suppliers
object[]
required
createdAt
string
required
updatedAt
string
required
launchWindow
string | null
estimatedVolume
number | null
globalMoq
number | null
htsCodeOverride
string | null
customFields
any | null
productOwnerUserId
string | null
currentProductVersionId
string | null
optionGroupCurveId
string | null
lastActivityAt
string | null
included
object