List catalog entries | Ottimate Developer Documentation

curl -G https://api.ottimate.com/v1/catalog/entries \
     -H "X-Api-Key: your-api-key-here" \
     -H "X-API-Version: 1.0.0" \
     -H "Authorization: Bearer <token>" \
     -d ottimate_company_id=15196 \
     -d page=1 \
     -d limit=50 \
     --data-urlencode expand=prices,allowances

{
  "count": 150,
  "results": [
    {
      "id": "cte_12345",
      "ottimate_company_id": 15196,
      "item_name": "Roma Tomatoes 6CT",
      "reference_id": "sysco-tomato",
      "description": "Roma Tomatoes 6CT",
      "sku": "SKU-TOM-001",
      "upc": "634987654321",
      "pack_size": "6 CT",
      "uom": "CASE",
      "price": "24.99",
      "unit_price": "4.17",
      "last_purchased_price": "25.50",
      "erp_vendor_id": "Sysco Foods",
      "erp_vendor_name": "Sysco",
      "is_split_case": false,
      "last_purchased_date": "2024-12-01T00:00:00Z",
      "last_purchased_date_utc": "2024-12-01T00:00:00.000000Z",
      "created_date": "2024-01-15T10:30:00Z",
      "created_date_utc": "2024-01-15T10:30:00.000000Z",
      "last_modified_date": "2024-12-01T14:22:00Z",
      "last_modified_date_utc": "2024-12-01T14:22:00.000000Z"
    },
    {
      "id": "cte_12346",
      "ottimate_company_id": 15196,
      "item_name": "Chicken Breast Boneless 40LB",
      "reference_id": "usfoods-chicken-breast",
      "description": "Chicken Breast Boneless 40LB",
      "sku": "SKU-CHK-002",
      "upc": "634987654322",
      "pack_size": "40 LB",
      "uom": "CASE",
      "price": "89.99",
      "unit_price": "2.25",
      "last_purchased_price": "88.50",
      "erp_vendor_id": "US Foods",
      "erp_vendor_name": "US Foods Inc",
      "is_split_case": false,
      "last_purchased_date": "2024-11-28T00:00:00Z",
      "last_purchased_date_utc": "2024-11-28T00:00:00.000000Z",
      "created_date": "2024-02-10T08:15:00Z",
      "created_date_utc": "2024-02-10T08:15:00.000000Z",
      "last_modified_date": "2024-11-28T11:45:00Z",
      "last_modified_date_utc": "2024-11-28T11:45:00.000000Z"
    }
  ],
  "page": 1,
  "per_page": 50
}

Returns a paginated list of catalog entries, filterable by company, vendor, and search term.

Authentication

AuthorizationBearer

OAuth2 authentication flows. Auth server URLs will vary by environment

Query parameters

ottimate_company_idintegerRequired

Filter entries by company ID (required)

erp_vendor_idstringOptional

Filter entries by vendor name

searchstringOptional

Search term based on item description or name

pageintegerOptional

Page number (default: 1)

limitintegerOptional<=100

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

expandstringOptional

Comma-separated list of fields to expand. Options: prices, allowances. When used, returns full CatalogEntryObject instead of CatalogEntryBasicObject.

skustringOptional

SKU code

upcstringOptional

UPC code

buying_formatstringOptional

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

sizestringOptional

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

uomstringOptional

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

pricedoubleOptional

Price for the pack size

unit_pricedoubleOptional

Price per individual unit within the pack

Response

Successful response with paginated catalog entry list

countinteger

Total number of results

resultslist of objects

List of catalog entries (uses CatalogEntryBasicObject by default, CatalogEntryObject when expand is used)

pageinteger

Current page number

per_pageinteger

Items per page

Errors

400

Bad Request Error

401

Unauthorized Error

Authentication

Headers

Query parameters

Response

Errors