POST
Add prices to an item
Company space For: Manager · Permission: variant_prices.create, bundle_prices.create Conditions
  • The permission depends on the type of item: variant_prices.create or bundle_prices.create.
  • prices is required with at least one entry; each entry needs a name, a price and a stockable_unit_id.
  • Each price is a decimal in major units, at least 0, with at most currency_exponent decimals.
  • Each unit must belong to the item and be active.
  • Within the company, a name can be used only once per unit (compared in lower case), including inside the same request.
  • Within the company, a price amount can be used only once per item, including inside the same request and across units.
  • The tax setup of the item must allow the price to be calculated: unknown tax identifiers, inapplicable VAT behavior or an incalculable amount refuse the call, and nothing is saved.
  • Tax settings must reference distinct tax identifiers.
What else happens
  • Stores prices as minor units for the caller’s company.
  • Stores the explicit tax inclusion settings of each price, with the VAT behavior as a setting on the item’s VAT tax, for the company’s current fiscal profile.
Part of Set prices and units of sale.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

stockable
string
required

Identifier of the sellable item (stockable): the stockable record of a product variant or of a bundle, not the variant or bundle identifier itself.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: vat_price_behavior, tax_settings, tax_configuration, id, name, stockable_id, stockable_unit_id, price, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource (only with response=resource).

id

Identifier of the price (27-character KSUID string).

name

Name of the price, for example retail; stored in lower case and unique per unit for the company.

stockable_id

Identifier of the item the price belongs to.

stockable_unit_id

Identifier of the unit of sale the price applies to.

price
number

Selling price in major units (stored internally in minor units and divided by 10 to the power currency_exponent).

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).

vat_price_behavior

inclusive when the price includes VAT, exclusive when VAT is added on top. exclusive when no VAT setting is stored for the price.

tax_settings
any[]

Explicit tax inclusion settings of the price: a list of objects with tax_id and inclusion_policy (inclusive or exclusive). Taxes without a setting use their default inclusion policy.

tax_configuration
object

Resolved tax calculation context of the price (tax_resolution, rounding_favor, taxes, inapplicable_tax_settings, calculation_error); fixed tax amounts in major units. Only present when the request sends include_tax_configuration=true.