Skip to main content
Set your API key and brand. Use exact lookups for identifiers from your ERP or PIM, then use the returned UUID for detail and relationship reads. All paths below start at /api/public/v1/brands/{brand}. Exact filters are case-sensitive. Product q search is case-insensitive and matches a literal substring, including % and _ as ordinary characters. Combine filters with AND; for example, code=TEE-001&status=active. Product Option names and external references can match several records, so every lookup returns items, nextCursor, and totalItems. Zero matches is an empty page. Unknown or invalid parameters return 400 instead of silently broadening a read. See filters by entity for the complete collection selector list.
Save amber-client.mjs, then run this with Node.js 22 or later and PRODUCT_CODE set to a known code:
find-product.mjs
Keep IDs as your local join keys. Product codes and names can change; the UUID identifies the same record across those edits. When paginating, preserve the brand, resource and filters. Reusing a cursor for a different lookup returns 400.

Find one shipment and read its contents

Use shipmentCode when you have Amber’s code. For carrier events, combine trackingNumber and carrierSlug; for imported shipments, combine externalShipmentId and source. A containerNumber lookup matches membership in the shipment’s containerNumbers array.
If you expect exactly one match, check totalItems before choosing it. Do not silently take items[0] when several records share a reference. This script fails on ambiguity and fetches only the selected shipment’s lines and cartons:
find-shipment.mjs

Find the cartons in a container

Use /shipment-containers when you need the physical container rather than the whole shipment. Each container record carries its shipmentId, containerNumber, seal, size, cartonCount, pallet counts, and dated milestones. Read its cartons from /shipment-cartons?shipmentContainerId=. The containerNumber filter ignores spaces, punctuation, and case, so mscu 123456-7 matches MSCU1234567. It also matches a number the forwarder later replaced. A container number reused on several shipments returns one container per shipment, so check shipmentId before you choose a record.
This script lists every container with that number and its cartons:
find-container.mjs
Shipment cartons include shipmentContainerId, palletNumber, and orderIds. shipmentContainerId and palletNumber are null when the carton is not assigned to a container. To find the shipment that carries a container, use /shipments?containerNumber=.

Disambiguate repeated references

Identifiers often belong to a parent or an issuing organization. Use both parts when you know them: These combinations help narrow your results, but business references can still match more than one record. Use the matching record’s stable ID for future reads.

Look up reference values before joining

Resolve /colors?code=NAVY or /materials?code=FAB-001 once, then use the returned IDs in relationship filters. For example, /material-variants accepts componentId, colorId, and supplierMaterialVariantCode. A child without its own business code is still addressable by its parent and related IDs: use /shipment-carton-items?shipmentCartonId={id}&skuId={id} to read one carton’s matching SKU rows. Boolean selectors use true or false. Integer selectors use ordinary whole numbers without leading zeros, such as versionNumber=0 or rowIndex=0. Always URL-encode values, especially email addresses, spaces, +, &, and #.