/api/public/v1/brands/{brand}. Collection filters
return the full matching set through pagination. A detail read
returns one record. Use collection filters to find assignments between records.
Products and libraries
Materials are the
/materials library; BOM components are instances in a BOM.
Resolve componentId through /materials/{id}, and componentVariantId through
/material-variants/{id}. Resolve colors, units, and BOM sections through their
library resources.
Dimension groups, curves, axes, axis values, and cells have separate collections.
A curve’s groupId resolves to /dimension-groups/{id}. Query
dimension-curve-axes?curveId=, then dimension-curve-axis-values?axisId=;
dimension-curve-cells?curveId= returns the sparse matrix. Product-specific
curves can also be listed with dimension-curves?productId=.
Quotes and samples
/quotes are the sourcing requests shown as Quotes in Amber. Use /quotes
for the collection and /quotes/{id} for a single quote.
Use quoteNumber for the display number and id for relationships.
Read a quote’s details for its dates, requirements, and custom fields. Its
price summary represents one revision and price band. For all offers, follow:
rfqId is the Quote ID. An item’s quoteId is the revision ID.
These identifiers are distinct. You can read submitted revisions and brand
drafts. Supplier-private drafts and canceled revisions are excluded.
Samples include their status and costs. Follow /sample-rounds?protoId= and
/sample-checklist-results?protoRoundId= for rounds, structured measurements,
and checklist outcomes. protoId is the Sample ID.
Samples, rounds, and checklist results are available only while their parent
product is visible in the authorized brand, including on direct detail reads.
Orders, logistics, and finance
An order includes a summary, line items, and references to its SKUs. Readdetails for dates, terms, custom fields, and exact decimal totals. Use
/order-items?orderId=, /order-amendments?orderId=, /production-runs?orderId=,
and production run items and revisions to follow its history.
Follow order shipment links into shipments, shipment items, containers, cartons
and carton contents, charges, legs, bookings, packing lists, and item lineages. Each resource
includes IDs you can use to find related records. The API Reference lists each
collection’s filters.
A shipment’s containers (/shipment-containers?shipmentId=) group its cartons;
read them with /shipment-cartons?shipmentContainerId=. Container reads are
available for every brand.
Inventory positions retain SKU and location references. Goods receipts and
receipt lines remain separate from shipment plans. Goods-receipt lines are the
only source of received quantities (qtyReceived).
Payment agreements and milestones describe planned terms. Payment obligations,
settlements, and receipts preserve their own identities and relationships.
Supplier invoices and invoice lines include amounts and order references.
Do not reconstruct these records from an order’s summary total.
Partners and locations
/partners returns active brand-linked partners with structured profile data and
the brand’s relationship defaults. /suppliers returns supplier summaries
using the same partner IDs. Read /contacts?partnerId= and
/partner-locations?partnerId= for contacts and structured addresses.
Use /partner-locations and /brand-locations to read address-book entries,
including the embedded location and whether it is a primary or billing
address. The /locations collection also includes transport locations
available to your brand.
Documents and downloads
/documents lists documents owned by your brand. To include documents shared
by a counterparty on an owned order or shipment, supply its subject:
subjectKind and subjectKey to collect all attachments for a record.
Keep document IDs exactly as returned, including any prefix. Use the same
subject parameters on /documents/{id} and /documents/{id}/content for shared
documents. Content returns a signed url, expiresAt, and optional file extent. Data-only
documents return 404 for content.
An attachment returns 404 if the record it belongs to is no longer available
to your brand.
subjects lists the orders, shipments, and payments currently linked to the
document and available to your brand. Superseded records are hidden
by default; use includeSuperseded=true to follow their history. Resolve
documentTypeId through /document-types/{id}.
Custom field values remain on their entities. Read /custom-field-definitions
for definitions. Structured JSON retains its nested content. Notes, checklists,
and reference libraries have their own collections.
Other supported file subjects include PRODUCT_VERSION, SKU, SAMPLE, SAMPLE_ROUND,
QUOTE, QUOTE_NOTE, MATERIAL, BOM_COMPONENT, and MEASUREMENT_TABLE. Supply that
entity ID as subjectKey. For files attached to your brand, use BRAND with
your brand ID as subjectKey. An unsupported subjectKind returns 400.
Quote discussions
/quotes/{quote.id}/notes returns a quote’s discussion thread: root
notes and their replies together, so a client can reconstruct the tree from
each note’s parentNoteId. Filter by productId or parentNoteId to narrow
further. Read a reply’s attachments with
/documents?subjectKind=QUOTE_NOTE&subjectKey={note.id}.
Mentions in note messages
When a user picks a person from the @mention picker, Amber stores that mention inside the note’smessage string as a token:
@Bob above, stays plain text. The
response has no separate mentions field.
- Display: replace each token with
@followed by its label. The label is the person’s name at save time, or their email if the name was empty. Inside the label,\]and\\are escaped; unescape them before display. - User ID: treat the ID after
user:as a hint only. Amber doesn’t verify it when the note is saved. A mention doesn’t prove that the person exists, is active, or can access the quote. - Label: the label can be stale. Amber doesn’t update it when the person changes their name.
Business notes
Use/notes?entityType=product&entityId={product.id} for brand-owned notes.
Supported entityType values are product, product_construction, order,
partner, rfq (Quote), and proto (Sample). Construction notes use the Parent
Product ID. Your brand’s note history remains readable when the referenced
entity is archived, deleted, or unlinked. Other entity types are excluded;
an unsupported entityType filter returns 400.
