Get Product Prices
GET https://api.secure.quotivity.com/v1/products/{productId}/pricesRetrieves all defined prices for a product
Send your API key in the x-api-key header. See Generating API keys.
Path parameters
Section titled “Path parameters”| Name | Type | Required | Description |
|---|---|---|---|
productId |
string | Yes | — |
Responses
Section titled “Responses”| Status | Body | Description |
|---|---|---|
200 |
ProductPriceDetails | Successfully retrieved product prices |
400 |
— | Invalid product |
401 |
— | Unauthorized |
500 |
— | Internal Server Error |
Schemas
Section titled “Schemas”OverrideAdjustment
Section titled “OverrideAdjustment”Extends PriceAdjustmentBase.
| Field | Type | Required | Description |
|---|---|---|---|
type |
override |
Yes | — |
amount |
number | Yes | — |
PercentAdjustment
Section titled “PercentAdjustment”Extends PriceAdjustmentBase.
| Field | Type | Required | Description |
|---|---|---|---|
type |
percent |
Yes | — |
amount |
number | Yes | — |
PriceAdjustmentBase
Section titled “PriceAdjustmentBase”| Field | Type | Required | Description |
|---|---|---|---|
type |
string | Yes | — |
PriceBookEntryAdjustment
Section titled “PriceBookEntryAdjustment”Type: OverrideAdjustment | PercentAdjustment | VolumeAdjustment | TableEnumAdjustment | TableRangeAdjustment | VariantAdjustment
PriceBookEntryAdjustmentWithResponseFlags
Section titled “PriceBookEntryAdjustmentWithResponseFlags”Per-currency adjustment as stored, plus allowUnitPriceEditing mirrored from the price book entry in read responses (not part of the persisted adjustment object).
Extends PriceBookEntryAdjustment.
| Field | Type | Required | Description |
|---|---|---|---|
allowUnitPriceEditing |
boolean | Yes | Entry-level flag for this product on the price book. |
ProductPriceDetails
Section titled “ProductPriceDetails”| Field | Type | Required | Description |
|---|---|---|---|
productId |
string | Yes | — |
prices |
ProductPrices[] | Yes | — |
standardPrice |
map of string to number | Yes | Price per currency. Keyed by ISO 4217 currency code (for example USD, EUR). A currency is absent, or null, when no price is set. |
properties |
map of string to string | Yes | — |
ProductPrices
Section titled “ProductPrices”| Field | Type | Required | Description |
|---|---|---|---|
priceBookId |
string | Yes | — |
priceBookName |
string | Yes | — |
listPrice |
map of string to number | Yes | Price per currency. Keyed by ISO 4217 currency code (for example USD, EUR). A currency is absent, or null, when no price is set. |
standardPrice |
map of string to number | Yes | Price per currency. Keyed by ISO 4217 currency code (for example USD, EUR). A currency is absent, or null, when no price is set. |
adjustments |
map of string to PriceBookEntryAdjustmentWithResponseFlags | Yes | Price adjustments keyed by ISO 4217 currency code (for example USD, EUR). The key is the currency; the value carries the adjustment only. |
TableEnumAdjustment
Section titled “TableEnumAdjustment”Extends PriceAdjustmentBase.
| Field | Type | Required | Description |
|---|---|---|---|
type |
enum |
Yes | — |
property |
string | Yes | — |
values |
object[] | Yes | — |
TableRangeAdjustment
Section titled “TableRangeAdjustment”Extends PriceAdjustmentBase.
| Field | Type | Required | Description |
|---|---|---|---|
type |
range |
Yes | — |
property |
string | Yes | — |
values |
object[] | Yes | — |
VariantAdjustment
Section titled “VariantAdjustment”Extends PriceAdjustmentBase.
| Field | Type | Required | Description |
|---|---|---|---|
type |
variant |
Yes | — |
values |
object[] | Yes | — |
VolumeAdjustment
Section titled “VolumeAdjustment”Extends PriceAdjustmentBase.
| Field | Type | Required | Description |
|---|---|---|---|
type |
volume |
Yes | — |
tiers |
object[] | Yes | — |
Ask the help center
Answers come from these guides, with links to the articles used.
Ask anything about configuring quoting in Quotivity Studio.