Sign in
catalog

List catalog entries

Returns a paginated list of catalog entries, filterable by company, vendor, and search term. Use expand=prices,allowances to populate properties, display_name, prices, and allowances keys or retrieve a single entry to populate them.

get/catalog/entries

Query parameters

ottimate_company_idinteger

Filter entries by company ID. If omitted, results are scoped to all companies the caller has access to.

erp_vendor_idstring

Filter entries by vendor name

searchstring

Search term matched against item name, description, sku, and upc.

pageinteger

Page number (default: 1)

limitinteger

Items per page (default: 50, max: 100)

expandstring

Comma-separated list of fields to expand. Options: prices, allowances — requesting either returns both.

skustring

SKU code

upcstring

UPC code

buying_formatstring

Buying format (e.g. 'CASE', 'EACH'). Pass 'null' to filter entries that have no buying format (NULL or empty).

sizestring

Pack size (e.g. '6 CT', '10 LB')

uomstring

Unit of measure (e.g. 'CASE', 'EACH', 'LB')

pricenumber double

Price for the pack size

unit_pricenumber double

Price per individual unit within the pack

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Successful response with paginated catalog entry list

countinteger required

Total number of results

pageinteger

Current page number

per_pageinteger

Items per page

Changes