GET
View a price
Company space For: Manager, Cashier and seller, Stock keeper, Buyer · Permission: variant_prices.retrieve, bundle_prices.retrieve Conditions
  • The permission depends on the type of item: variant_prices.retrieve or bundle_prices.retrieve.
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.

price
string
required

Identifier of the price, which must belong to the item in the URL and to the caller's company.

Query Parameters

response
enum<string>
default:resource

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

Available options:
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

200 - application/json

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.