amber-client.mjs, and choose a
PRODUCT_ID with /products?code=TEE-001. Use Node.js 22 or later for the script.
1
Request the relationships you need
include=all. The response is a product
object with an included object, not an items envelope around the product.
Each entry in included has items, totalItems, nextCursor, and url.Use
includeLimit=100 for up to 100 rows in each relationship. The default
is 25. The shared productGraph() helper below follows every continuation
and returns completed arrays.2
Finish every included collection
The script writes a JSON file with product details in Empty arrays mean no related records are available to your brand. Missing
include names mean they were not requested. This script collects one product
in memory; stream records to storage instead for unusually large graphs.
product and the
complete related collections in relationships.product-specifications.mjs
3
Keep versions and assignments distinct
Use
product.currentProductVersionId, when present, to locate the current
row in relationships.versions. Do not assume the first version is current
or the highest-numbered version is the version referenced by an order.Preserve version
technicalSpecs, packagingSpecs, labelingSpecs, and
sizeSpecs, along with measurement-table sizeSpecs and BOM
constructionAnnotations, as nested JSON. Their structure can contain
more information than a flattened spreadsheet.Fetch one version directly
If an order or quote supplies aproductVersionId, use that ID to read
/product-versions/{id}, /boms?productVersionId={id}, and
/measurement-tables?productVersionId={id}. These reads avoid loading other
versions. Finish the BOM with /bom-components?bomId={id}.
Add samples, quotes, and files
all means all supported product expansions, not every business record
that references the product. Read samples with /samples?productId={id},
their rounds with /sample-rounds?protoId={sample.id}, and checklist results
with /sample-checklist-results?protoRoundId={round.id}. Quotes and orders have
their own workflows.
The documents expansion contains Parent Product files. Product Option,
version, SKU, Sample, and other file subjects need their own document queries.
The images expansion covers a wider product graph. Follow
Download documents and images to retrieve bytes.
Budget for repeated reads
include=all uses 31 expansion credits. You can request two full expansions
immediately, and credits replenish at 1,000 per hour by default. After the initial
burst, that is roughly 32 full expansions per hour for a continuously busy key,
before accounting for other expansion requests. Honor Retry-After on 429.
Continuation requests use the regular request quota and no expansion credits.
Choose a smaller include set for interactive reads. For a whole-brand export,
page the collections directly and join their IDs as in
Export your catalog. See Product graphs
for expansion semantics and Authentication for limits.
