Skip to navigation
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

This endpoint expects an object.
erp_vendor_idstringOptional

ERP Vendor id from ERP/accounting system

catalog_unique_keystring or nullOptional

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_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<=256 characters

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.

dimensionslist of maps from strings to strings or map from strings to stringsOptional

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.

propertiesobjectOptional
Additional properties

Response

Catalog entry updated successfully

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error