Skip to main content
Use these selectors on GET /api/public/v1/brands/{brand}/{collection}. If you already have an ID, use the detail endpoint shown in API Reference. For code, tracking, and invoice examples, start with Find records by business identifiers. All filters below are optional. A record must match every filter you supply. totalItems counts all matching records across pages. Responses use the { items, nextCursor, totalItems } shape, even for a unique match. Collections also accept limit and cursor; see pagination. Text lookups are exact and case-sensitive, with literal spaces and punctuation. Product q is a case-insensitive literal substring search. Document-type domain is case-insensitive. Boolean selectors use true or false; integer selectors use whole numbers from 0 to 2147483647 without leading zeros. IDs ending in Id use the identifier format in API Reference, usually UUIDs. Unknown selectors return 400.

Pick the right scope

  • A lookup only returns records visible to your key’s brand. A matching code does not override visibility or include deleted records.
  • Supplier status and Partner partnerStatus describe the partner’s status. Suppliers still require an active link to the brand.
  • containerNumber on shipments matches an element of containerNumbers. categoryId on packing templates matches an element of categoryIds.
  • containerNumber on shipment containers ignores spaces, punctuation and case, and also matches a number the forwarder replaced. A number reused across shipments returns one container per shipment, each with its shipmentId.
  • Document metadata selectors apply to /documents lists. Keep subject subjectKind and subjectKey together when reading a particular attachment. dataValue and issuerName match documents with those values; attachments without them do not match. Images use filename, while documents use fileName, matching each resource’s response fields.
  • For records without their own code, filter by the parent or related record ID. See entity relationships for examples.

Catalog

Sourcing and samples

Orders and production

Logistics and receipts

Invoices and payments

Partners and locations

Files and notes

Reference data