For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact UsDashboard
DocumentationAPI ReferenceChangelog
DocumentationAPI ReferenceChangelog
  • API Reference
      • GETList catalog entries
      • POSTCreate a catalog entry
      • GETRetrieve a catalog entry
      • PATCHUpdate a catalog entry
      • GETList catalog allowances
      • POSTCreate a catalog allowance
      • PATCHUpdate a catalog allowance
      • GETList catalog variances
      • POSTBulk create/update catalog entries (async)
      • POSTBulk create/update catalog allowances (async)
      • POSTBulk create catalog prices (async)
      • GETGet invoice items for a catalog entry
      • GETList exported catalog variance batches
      • POSTExport a catalog variance batch (local only)
      • GETList catalog prices
      • POSTCreate a catalog price
LogoLogo
Contact UsDashboard
API ReferenceCatalog

List catalog entries

GET
/catalog/entries
GET
/v1/catalog/entries
$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
1{
2  "count": 150,
3  "results": [
4    {
5      "id": "cte_12345",
6      "ottimate_company_id": 15196,
7      "item_name": "Roma Tomatoes 6CT",
8      "reference_id": "sysco-tomato",
9      "description": "Roma Tomatoes 6CT",
10      "sku": "SKU-TOM-001",
11      "upc": "634987654321",
12      "pack_size": "6 CT",
13      "uom": "CASE",
14      "price": "24.99",
15      "unit_price": "4.17",
16      "last_purchased_price": "25.50",
17      "erp_vendor_id": "Sysco Foods",
18      "erp_vendor_name": "Sysco",
19      "is_split_case": false,
20      "last_purchased_date": "2024-12-01T00:00:00Z",
21      "created_date": "2024-01-15T10:30:00Z",
22      "last_modified_date": "2024-12-01T14:22:00Z"
23    },
24    {
25      "id": "cte_12346",
26      "ottimate_company_id": 15196,
27      "item_name": "Chicken Breast Boneless 40LB",
28      "reference_id": "usfoods-chicken-breast",
29      "description": "Chicken Breast Boneless 40LB",
30      "sku": "SKU-CHK-002",
31      "upc": "634987654322",
32      "pack_size": "40 LB",
33      "uom": "CASE",
34      "price": "89.99",
35      "unit_price": "2.25",
36      "last_purchased_price": "88.50",
37      "erp_vendor_id": "US Foods",
38      "erp_vendor_name": "US Foods Inc",
39      "is_split_case": false,
40      "last_purchased_date": "2024-11-28T00:00:00Z",
41      "created_date": "2024-02-10T08:15:00Z",
42      "last_modified_date": "2024-11-28T11:45:00Z"
43    }
44  ],
45  "page": 1,
46  "per_page": 50
47}
Returns a paginated list of catalog entries, filterable by company, vendor, and search term.
Was this page helpful?
Previous

Create a catalog entry

Next
Built with

Authentication

AuthorizationBearer
OAuth2 authentication flows. Auth server URLs will vary by environment

Headers

X-Api-KeystringRequired
API key for authentication
X-API-VersionenumOptional

API version to use (optional, defaults to latest)

Allowed values:

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.

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