Sign in

v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB
catalog

Update a catalog entry

Updates an existing catalog entry by ID.

patch/catalog/entries/{id}

Path parameters

idstring required

The unique ID of the catalog entry

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.

Request body

erp_vendor_idstring

ERP Vendor id from ERP/accounting system

item_namestring

Item name for the catalog entry

descriptionstring

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

original_descriptionstring

Original item description

skustring

SKU code

upcstring

UPC code

buying_formatstring nullable

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.

sizestring

Pack size

uomstring

Unit of measure

pricenumber double

Price

unit_pricenumber double

Unit price

is_split_caseboolean

Split case indicator

authorized_vendorboolean

Whether vendor is authorized

erp_vendor_namestring nullable

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.

{"stackTrail":"paths:/catalog/entries/{id}:patch:requestBody:content:application/json:schema:properties:dimensions","oasType":"schema","type":"unknown","description":"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."}
propertiesCatalogEntriesIdPatchRequestBodyContentApplicationJsonSchema

Additional properties

Response

Catalog entry updated successfully

idstring required

Unique identifier (prefixed with cte_)

ottimate_company_idinteger required

Company ID

reference_idstring

Unique key for the catalog entry

item_namestring required

Item name 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 nullable

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 nullable

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

erp_vendor_namestring nullable

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

is_split_caseboolean

Split case indicator

{"stackTrail":"components:schemas:CatalogEntryObject:properties:dimensions:oneOf","oasType":"schema","type":"unknown","description":"Any type","nullable":true}
display_namestring

Display name for the item

last_purchased_datestring

Last purchased date

last_purchased_date_utcstring date-time nullable

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

created_datestring date-time

Record creation date

created_date_utcstring date-time nullable

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

last_modified_datestring date-time

Record last modified date

last_modified_date_utcstring date-time nullable

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