Update a catalog entry
Updates an existing catalog entry by ID.
API version to use (optional, defaults to latest)
ERP Vendor id from ERP/accounting system
Deprecated: use item_name instead. This field will be removed in a future API version.
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.
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.
Unique identifier (prefixed with cte_)
Deprecated: use item_name instead. This field will be removed in a future API version.
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.
Price (decimal string)
Unit price (decimal string)
Last purchased price (decimal string)
ERP Vendor id from ERP/accounting system
Deprecated. Use erp_vendor_name instead. Same value, kept for backward compatibility; will be removed in a future API version.
(Beta — this field is available in sandbox and not yet in production.) Human-readable vendor name attached to erp_vendor_id, sourced from the originating system. Nullable when not provided.
Resolved dimensions keyed by uppercase dimension type (e.g. DEPARTMENT, SUB_DEPARTMENT, CATEGORY, SUBCATEGORY, PROJECT, CLASS). Each value is the dimension name (or code if name is unavailable).
List of catalog prices (only in retrieve or when expand=prices)
List of catalog allowances (only in retrieve or when expand=allowances)
Dimension values keyed by type. Standard supported types include department, sub_department, category, subcategory, plus any custom Dimension types configured for the company (e.g. PROJECT, CLASS). Keys are case-insensitive on input; responses return uppercased keys (e.g. DEPARTMENT, CATEGORY). 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.