Update Item

patch

https://api.scalepad.com/quoter/v1/items/{id}

Modifies the properties or configuration of an existing item.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Item ID

Query Params

fields

string

enum

One or more response fields, separated by commas.

Body Params

Request body to update an Item.

Used to update the details of an existing item.

allow_decimal_quantities

boolean

Whether fractional quantities are allowed when selling this item.

category

string

Name of the item's category. Cannot be provided with category_id.

category_id

string

Unique ID of the category. Cannot be provided with category.

code

string

Custom item code.

cost_decimal

string

Unit cost expressed as a decimal. If provided, pricing_scheme must be flat, per_unit, or percentage.

cost_type

string

enum

Indicates how to interpret the item's cost (e.g., flat, percentage). If provided, pricing_scheme must be flat, per_unit, or percentage; required if cost is provided. Defaults to amount if an empty value is specified.

Allowed:

description

string

Item description.

internal_note

string

Notes for internal use.

manufacturer

string

Name of the item's manufacturer. Cannot be provided with manufacturer_id.

manufacturer_id

string

Unique ID of the manufacturer. Cannot be provided with manufacturer.

name

string

Name of the item.

percentage_price_category_ids

array of strings

List of category IDs for percentage-based pricing. If provided, pricing_scheme must be percentage; required if pricing_scheme is percentage.

percentage_price_category_ids

percentage_price_decimal

string

Percentage used for pricing. If provided, pricing_scheme must be percentage; required if pricing scheme is percentage.

price_decimal

string

Unit price of the item. If provided, pricing_scheme must be flat or per_unit; validate decimal.

pricing_scheme

string

enum

The method used to calculate the item's price. Defaults to per_unit if omitted.

Allowed:

quantity_help_tip

string

Tooltip or help text related to quantity selection.

recurring

boolean

Whether the item is billed on a recurring schedule.

recurring_interval

string

enum

Billing interval for recurring items. If provided, recurring must be true; required if recurring is true.

Allowed:

restrict_discounting

boolean

Disables discounts on the item.

show_option_prices

boolean

Whether to display option prices next to the base price.

sku

string

Stock keeping unit for inventory tracking.

supplier

string

Name of the supplier. Cannot be provided with supplier_id.

supplier_id

string

ID of the supplier. Cannot be provided with supplier.

taxable

boolean

Indicates whether the item is taxable. Defaults to true if omitted.

weight_decimal

string

Item weight in decimal format.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Item updated.

404Record not found.