Create Item

post

https://api.scalepad.com/quoter/v1/items

Adds a new item to your product catalog.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

fields

string

enum

One or more response fields, separated by commas.

Body Params

Request body to create an Item.

Used to create a new item in the system.

allow_decimal_quantities

boolean

Whether the item can be sold in fractional quantities.

category

string

Name of the category to which the item belongs. Required; cannot be provided with category_id.

category_id

string

required

ID of the category to which the item belongs. Required; cannot be provided with category.

code

string

Custom reference code for the item.

cost_decimal

string

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

cost_type

string

enum

Type of cost (e.g., amount, percentage), used to interpret the cost value. If provided, pricing_scheme must be flat, per_unit, or percentage; required if cost is provided. Defaults to amount if not specified.

Allowed:

description

string

Textual description of the item.

internal_note

string

Private notes about the item, not visible to customers.

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

required

Name of the item being created.

percentage_price_category_ids

array of strings

Category IDs used 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

The percentage markup or markdown used in pricing. If provided, pricing_scheme must be percentage; required if pricing scheme is percentage.

price_decimal

string

Price of the item in decimal format. If provided, pricing_scheme must be flat or per_unit; validate decimal.

pricing_scheme

string

enum

Method used for pricing, such as flat, per_unit, or percentage. Defaults to per_unit if omitted.

Allowed:

quantity_help_tip

string

Help text to guide users on how to select quantity.

recurring

boolean

Indicates whether the item is billed on a recurring basis.

recurring_interval

string

enum

Time interval for recurring billing (e.g., monthly, yearly). If provided, recurring must be true; required if recurring is true.

Allowed:

restrict_discounting

boolean

Prevents discounts from being applied to this item.

show_option_prices

boolean

Indicates whether option prices should be displayed alongside item price.

sku

string

Unique product code used for tracking inventory.

supplier

string

Name of the item's supplier. Cannot be provided with supplier_id.

supplier_id

string

ID of the item's supplier. Cannot be provided with supplier.

taxable

boolean

Whether the item is subject to tax. 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

201Item created.

404Record not found.