API ReferenceCatalog

Update a catalog entry

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-VersionstringOptional

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

Request

erp_vendor_idstringOptional

ERP Vendor id from ERP/accounting system

item_namestringOptional
Item name for the catalog entry
descriptionstringOptional

Deprecated: use item_name instead. This field will be removed in a future API version.

original_descriptionstringOptional
Original item description
skustringOptional
SKU code
upcstringOptional
UPC code
buying_formatstring or nullOptional

Buying format distinguishing multiple purchasing formats for the same item (e.g., ‘CASE’, ‘EACH’). Used as part of the composite unique key for integrations that differentiate catalog entries by buying format. Optional — null or omitted for integrations that do not use buying format.

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
erp_vendor_namestring or nullOptional

Optional. Human-readable vendor name attached to erp_vendor_id, sourced from the originating system. Note: reads return the resolved vendor name for the entry, which may come from upstream ERP/sync sources rather than this field. Omit to leave unchanged; pass empty string to clear.

dimensionsanyOptional
POS dimensions for this catalog entry — these are point-of-sale system dimensions, separate from ERP/accounting dimensions and not validated against your accounting configuration. Input Structure: a list of objects, each with one dimension-type key (value = dimension name) plus an optional 'code', e.g. [{"DEPARTMENT": "Marketing", "code": "321654"}]. Omit the field or pass null to leave dimensions unchanged.
propertiesobjectOptional
Additional properties

Response

Catalog entry updated successfully
idstring

Unique identifier (prefixed with cte_)

ottimate_company_idinteger
Company ID
item_namestring
Item name for the catalog entry
reference_idstring
Unique key for the catalog entry
descriptionstring

Deprecated: use item_name instead. This field will be removed in a future API version.

skustring
SKU code
upcstring
UPC code
buying_formatstring or null

Buying format distinguishing multiple purchasing formats for the same item (e.g., ‘CASE’, ‘EACH’). Used as part of the composite unique key for integrations that differentiate catalog entries by buying format. Optional — null or omitted for integrations that do not use buying format.

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 or null

Deprecated. Use erp_vendor_name instead. Same value, kept for backward compatibility; will be removed in a future API version.

erp_vendor_namestring or null

Human-readable vendor name attached to erp_vendor_id, sourced from the originating system. Nullable when not provided.

is_split_caseboolean
Split case indicator
dimensionsany or null

POS dimensions. When the entry was submitted with dimension codes, the response mirrors the input list format: an array of objects each with one dimension-type key (value = name) plus a ‘code’ field. When no codes are present the legacy object format is used: keys are uppercase dimension types, values are dimension names. Null when no dimensions are set.

display_namestring
Display name for the item
last_purchased_datestring
Last purchased date
last_purchased_date_utcstring or nullformat: "date-time"

UTC equivalent of last_purchased_date. ISO 8601 with Z suffix, e.g. “2025-05-20T15:17:35.652584Z”.

created_datestringformat: "date-time"
Record creation date
created_date_utcstring or nullformat: "date-time"

UTC equivalent of created_date. ISO 8601 with Z suffix, e.g. “2025-05-20T15:17:35.652584Z”.

last_modified_datestringformat: "date-time"
Record last modified date
last_modified_date_utcstring or nullformat: "date-time"

UTC equivalent of last_modified_date. ISO 8601 with Z suffix, e.g. “2025-05-20T15:17:35.652584Z”.

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)

warningslist of objects

Soft-validation warnings. Present when the prices or allowances field was absent from the request.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error