API ReferenceCatalog

Update a catalog entry

Beta
Updates an existing catalog entry by ID.

Authentication

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

Path parameters

idstringRequired
The unique ID of the catalog entry

Headers

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

API version to use (optional, defaults to latest)

Allowed values:

Request

erp_vendor_idstringOptional

ERP Vendor id from ERP/accounting system

descriptionstringOptional

Item name/description

original_descriptionstringOptional
Original item description
skustringOptional
SKU code
upcstringOptional
UPC code
sizestringOptional
Pack size
uomstringOptional
Unit of measure
pricedoubleOptional
Price
unit_pricedoubleOptional
Unit price
is_split_casebooleanOptional
Split case indicator
authorized_vendorbooleanOptional
Whether vendor is authorized
dimensionsobject or nullOptional

Dimension values keyed by type (e.g. PROJECT, CLASS). Each value is the ERP external_id of the dimension. When provided, REPLACES all existing dimensions on the entry — include every dimension you want to keep. Omit the field or pass null to leave dimensions unchanged. Passing returns 400.

propertiesobjectOptional
Additional properties

Response

Catalog entry updated successfully
idstring

Unique identifier (prefixed with cte_)

ottimate_company_idinteger
Company ID
reference_idstring
Unique key for the catalog entry
descriptionstring
Item name
skustring
SKU code
upcstring
UPC code
pack_sizestring
Pack size
uomstring
Unit of measure
pricestring

Price (decimal string)

unit_pricestring

Unit price (decimal string)

last_purchased_pricestring

Last purchased price (decimal string)

erp_vendor_idstring

ERP Vendor id from ERP/accounting system

ottimate_vendor_namestring
Ottimate's resolved vendor name
is_split_caseboolean
Split case indicator
dimensionsobject or null

Resolved dimensions keyed by type. Each value is the dimension name (or code if name is unavailable).

display_namestring
Display name for the item
last_purchased_datestring
Last purchased date
created_datestringformat: "date-time"
Record creation date
last_modified_datestringformat: "date-time"
Record last modified date
priceslist of objects

List of catalog prices (only in retrieve or when expand=prices)

allowanceslist of objects

List of catalog allowances (only in retrieve or when expand=allowances)

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error