Sign in
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

catalog_unique_keystring nullable

Accepted but has no effect. On every save, catalog_unique_key is unconditionally regenerated from the company's configured key format (see catalog_unique_key on the create request) — a value submitted here is not stored and does not rename or override the entry's key.

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\"}]. Dimension-type keys are uppercased in the response regardless of the case submitted. Omit the field or pass null to leave dimensions unchanged."}
propertiesCatalogEntriesIdPatchRequestBodyContentApplicationJsonSchema

Additional properties

Response

Catalog entry updated successfully

CatalogEntryObject required

Customer-supplied custom key-value properties. On every write (create or update), Ottimate also stores the raw submitted request body under a reserved "public_api_request" key inside this same object — this key is not customer data, is overwritten (not merged/accumulated) on each write to always reflect the most recent request, and will appear in read responses alongside whatever custom properties you submit.

Changes