Skip to main content

Catalog Items

The items in your organization's catalog. Use this list to keep an external system in sync: page through every result once, store the latest updatedAt you received, and on the next sync pass it as filter.updatedAt_gte.

Schema​

CatalogItem​

NameTypeDescriptionExample
idIDUnique identifier for the catalog item"ckmnpybisiy5x08abky4g2d1f"
skuString?Your organization's unique SKU for the catalog item"EMT-075"
descriptionString?Description of the catalog item"3/4\" EMT Conduit"
nicknameString?The name your organization gave the catalog item"3/4 EMT"
searchTermsString[]Your organization's search terms for the catalog item["conduit", "EMT 3/4"]
manufacturerNameString?Name of the manufacturer"Allied Tube"
manufacturerPartNumberString?The manufacturer part number"101543"
universalProductCodeString?The universal product code"786564101543"
unitsOfMeasureString?The unit of measure for the catalog item"FT"
disabledBooleanWhether the catalog item is disabledfalse
updatedAtDateTime?When this catalog item was last updated"2026-03-24T17:26:46.983Z"

Queries​

catalogItems​

Get the organization's catalog items, ordered by updatedAt from oldest to newest.

Parameters​

This query uses cursor pagination instead of the standard pagination parameters.

NameTypeDescription
limitInt?Maximum number of items per page. Defaults to and is capped at 500
cursorString?The nextCursor value from the previous page. Omit it to get the first page
filterCatalogItemFilter?updatedAt_gte: only return items updated at or after this time

A page can hold fewer items than limit, or none, while more pages remain. Keep requesting pages until nextCursor is null. An invalid cursor returns an error.

Response​

A CatalogItemsResponse:

NameTypeDescription
countIntTotal number of matches for the filter
itemsCatalogItem[]The catalog items on this page
nextCursorString?Cursor for the next page, or null on the last page

Example Request​

query {
catalogItems(limit: 100, filter: { updatedAt_gte: "2026-01-01T00:00:00.000Z" }) {
count
nextCursor
items {
id
sku
updatedAt
}
}
}

Example Response​

{
"count": 1,
"nextCursor": null,
"items": [
{
"id": "ckmnpybisiy5x08abky4g2d1f",
"sku": "EMT-075",
"updatedAt": "2026-03-24T17:26:46.983Z"
}
]
}