> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amber.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Filters by entity

> Find the public collection and selectors for a known code, reference, name, or related record

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](/tutorials/find-records).

All selectors below are optional and combine with AND. Matches are filtered
before pagination, and `totalItems` counts the full matching set. Responses
retain the standard `{ items, nextCursor, totalItems }` shape, even for a unique
match. Collections also accept `limit` and `cursor`; see [pagination](/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`.
* Document metadata selectors apply to `/documents` lists. Keep subject
  `subjectKind` and `subjectKey` together when reading a particular attachment.
  `dataValue` and `issuerName` match populated native document metadata; legacy
  attachments without those values do not match. Images use `filename`, while
  documents use `fileName`, matching each resource's response fields.
* Child and join collections use parent IDs and related IDs when they have no
  independent code. See [entity relationships](/entity-relationships) for joins.

## Catalog

| Collection | Supported selectors |
| - | - |
| `/products` | `code`, `status`, `categoryId`, `q` |
| `/product-options` | `vendorFacingProductName`, `channel`, `launchWindow`, `name`, `status`, `productId`, `supplierId`, `collectionId`, `measurementTableId` |
| `/skus` | `code`, `upc`, `status`, `productId`, `productOptionId`, `colorId` |
| `/product-versions` | `versionNumber`, `versionName`, `status`, `isActive`, `baseVersionId`, `productId`, `partnerId`, `protoId` |
| `/boms` | `name`, `isDefault`, `productVersionId`, `productId` |
| `/bom-components` | `name`, `bomSectionId`, `showOnPo`, `bomId`, `componentId`, `componentVariantId`, `productId` |
| `/bom-skus` | `bomId`, `skuId`, `productId` |
| `/measurement-tables` | `name`, `productVersionId`, `productId` |
| `/measurement-table-skus` | `measurementTableId`, `skuId`, `productId` |
| `/product-relations` | `relatedProductId`, `relationType`, `productId` |
| `/product-option-values` | `productOptionId`, `optionValueId`, `productId` |
| `/product-option-dimension-values` | `productOptionId`, `dimensionValueId`, `productId` |
| `/product-option-prices` | `kind`, `currency`, `productOptionId`, `productId` |
| `/product-option-collections` | `productOptionId`, `collectionId`, `productId` |
| `/sku-dimension-values` | `skuId`, `dimensionValueId`, `productId` |
| `/product-collections` | `productId`, `collectionId` |
| `/product-tags` | `productId`, `tagId` |
| `/product-launch-windows` | `productId`, `launchWindowId` |

## Sourcing and samples

| Collection | Supported selectors |
| - | - |
| `/suppliers` | `name`, `shortName`, `status`, `countryCode`, `slug` |
| `/quotes` | `quoteNumber`, `status`, `supplierId`, `productId` |
| `/quote-revisions` | `round`, `status`, `isBrandQuote`, `rfqId` |
| `/quote-items` | `quoteId`, `skuId`, `productVersionId` |
| `/quote-price-bands` | `bandNumber`, `quoteItemId` |
| `/quote-notes` | `supplierId`, `resolved`, `senderType`, `quoteId`, `productId`, `parentNoteId` |
| `/samples` | `code`, `status`, `productId`, `supplierId` |
| `/sample-rounds` | `trackingNumber`, `status`, `sampleStage`, `referenceBomId`, `protoId` |
| `/sample-checklist-results` | `checklistId`, `protoRoundId` |

## Orders and production

| Collection | Supported selectors |
| - | - |
| `/orders` | `orderNumber`, `externalOrderCode`, `status`, `supplierId` |
| `/order-items` | `itemType`, `orderId`, `skuId`, `productVersionId` |
| `/order-amendments` | `revisionNumber`, `revisionId`, `status`, `orderId` |
| `/production-runs` | `runNumber`, `originId`, `orderId` |
| `/production-run-items` | `productionRunId`, `orderItemId` |
| `/production-run-item-revisions` | `productionRunItemId` |

## Logistics and receipts

| Collection | Supported selectors |
| - | - |
| `/shipments` | `shipmentCode`, `trackingNumber`, `carrier`, `carrierSlug`, `freightForwarder`, `shipmentMode`, `houseBillNumber`, `masterBillNumber`, `externalShipmentId`, `externalBookingReference`, `source`, `status`, `dischargeLocationId`, `pickupLocationId`, `containerNumber`, `originId`, `destinationId` |
| `/shipment-items` | `sku`, `purchaseOrderNumber`, `externalShipmentItemId`, `lineNumber`, `shipmentId`, `orderItemId` |
| `/shipment-cartons` | `cartonNumber`, `packingListId`, `cartonSizeId`, `source`, `shipmentId`, `orderId` |
| `/shipment-carton-items` | `shipmentCartonId`, `skuId`, `orderItemId` |
| `/shipment-charges` | `trackingNumber`, `invoiceNumber`, `lineNumber`, `chargeType`, `shipmentId`, `documentId` |
| `/order-shipments` | `orderId`, `shipmentId` |
| `/legs` | `originId`, `destinationId`, `status`, `orderId`, `sourceShipmentId` |
| `/leg-items` | `productionRunId`, `legId`, `orderItemId` |
| `/bookings` | `externalBookingId`, `externalBookingReference`, `source`, `pushStatus`, `originId`, `destinationId`, `origin`, `orderId`, `sourceLegId` |
| `/booking-items` | `legId`, `legItemId`, `productionRunId`, `bookingId`, `orderItemId` |
| `/shipment-bookings` | `shipmentId`, `bookingId` |
| `/shipment-item-lineages` | `shipmentItemId`, `bookingItemId`, `legItemId` |
| `/packing-lists` | `reference`, `supplierId`, `documentId`, `grain`, `orderId`, `shipmentId` |
| `/packing-list-lines` | `sku`, `packingListId`, `orderItemId`, `skuId` |
| `/goods-receipts` | `receiptNumber`, `orderId`, `supplierId`, `documentId` |
| `/goods-receipt-lines` | `goodsReceiptId`, `orderItemId`, `skuId` |
| `/inventory` | `skuId`, `addressId` |

## Invoices and payments

| Collection | Supported selectors |
| - | - |
| `/invoices` | `invoiceNumber`, `issuerPartnerId`, `currency`, `orderId`, `supplierId`, `documentId` |
| `/invoice-lines` | `partnerInvoiceId`, `orderItemId`, `skuId` |
| `/payment-agreements` | `paymentTermId`, `currency`, `status`, `orderId` |
| `/payment-milestones` | `label`, `triggerEvent`, `sequence`, `basis`, `agreementId` |
| `/payments` | `code`, `sourceKind`, `sourceKey`, `scopeKey`, `groupRef`, `currency`, `onHold`, `orderId`, `payeeSupplierId` |
| `/payment-settlements` | `settlementKey`, `externalReference`, `receiptDocumentId`, `track`, `currency`, `obligationId`, `partnerInvoiceId` |
| `/payment-receipts` | `paymentReference`, `currency`, `documentId`, `resolvedPayeeId` |

## Partners and locations

| Collection | Supported selectors |
| - | - |
| `/partners` | `slug`, `name`, `shortName`, `countryCode`, `midCode`, `businessRegistrationNumber`, `taxId`, `partnerStatus` |
| `/contacts` | `name`, `email`, `company`, `partnerId` |
| `/locations` | `name`, `type`, `countryCode`, `unLocode`, `city`, `postalCode` |
| `/brand-locations` | `type`, `isPrimary`, `isBilling`, `isDefaultBilling`, `locationId` |
| `/partner-locations` | `type`, `isPrimary`, `partnerId`, `locationId` |

## Files and notes

| Collection | Supported selectors |
| - | - |
| `/documents` | `subjectKind`, `subjectKey`, `documentTypeId`, `includeSuperseded`, `fileName`, `mimeType`, `dataValue`, `issuerName` |
| `/document-types` | `code`, `name`, `kind`, `domain` |
| `/images` | `filename`, `title`, `category`, `mimeType`, `isThumbnail`, `entityId`, `entityType`, `productId` |
| `/notes` | `entityId`, `entityType` |

## Reference data

| Collection | Supported selectors |
| - | - |
| `/materials` | `code`, `name`, `supplier`, `supplierProductCode`, `status`, `productId`, `bomSectionId` |
| `/material-variants` | `supplierMaterialVariantCode`, `supplierMaterialVariantName`, `status`, `productId`, `componentId`, `colorId` |
| `/bom-sections` | `code`, `name`, `productId` |
| `/categories` | `code`, `name`, `productId`, `parentId` |
| `/collections` | `code`, `name`, `productId` |
| `/launch-windows` | `code`, `name`, `productId`, `collectionId` |
| `/tags` | `code`, `name`, `productId` |
| `/colors` | `code`, `name`, `status`, `productId` |
| `/options` | `key`, `name`, `productId` |
| `/option-values` | `code`, `name`, `status`, `productId`, `optionId` |
| `/dimensions` | `code`, `name`, `productId` |
| `/dimension-values` | `value`, `customerFacingLabel`, `skuCode`, `sequence`, `productId`, `dimensionId` |
| `/dimension-groups` | `name` |
| `/dimension-group-dimensions` | `groupId`, `dimensionId` |
| `/dimension-curves` | `name`, `isPrivate`, `groupId`, `productId` |
| `/dimension-curve-axes` | `curveId`, `dimensionId` |
| `/dimension-curve-axis-values` | `valueLabel`, `dimensionValueId`, `sequence`, `axisId` |
| `/dimension-curve-cells` | `rowIndex`, `colIndex`, `curveId` |
| `/checklists` | `name`, `categoryId`, `productId` |
| `/packing-templates` | `name`, `isDefault`, `categoryId` |
| `/carton-sizes` | `name` |
| `/couriers` | `name`, `accountNumber`, `isActive` |
| `/payment-terms` | `name`, `isDefault`, `partnerId` |
| `/units-of-measure` | `code`, `name`, `type` |
| `/countries` | `code`, `name` |
| `/custom-field-definitions` | `fieldKey`, `entityField`, `fieldType`, `label`, `isActive`, `entityType` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.