Search Price Book Priced Products
GET https://api.secure.quotivity.com/v1/pricebooks/{priceBookId}/pricedProductsSearch products already in a price book and populates their prices.
Send your API key in the x-api-key header. See Generating API keys.
Path parameters
Section titled “Path parameters”| Name | Type | Required | Description |
|---|---|---|---|
priceBookId |
string | Yes | — |
Query parameters
Section titled “Query parameters”| Name | Type | Required | Description |
|---|---|---|---|
searchKeyword |
string | No | — |
limit |
string | No | — |
after |
string | No | — |
amount |
string | No | Reserved for future use. |
Responses
Section titled “Responses”| Status | Body | Description |
|---|---|---|
200 |
SearchPriceBookPricedProductsResponse | Search results |
401 |
— | Unauthorized |
500 |
— | Internal Server Error |
Schemas
Section titled “Schemas”CostPlusAdjustment
Section titled “CostPlusAdjustment”Derives the list price from the product’s hs_cost_of_goods_sold: basis amount adds value to cost; basis percent applies value as a fraction of cost (0.3 = 30%) as a markup (cost × (1 + value)) or a margin (cost ÷ (1 − value)). Non-primary currencies convert the cost with the account’s cached HubSpot exchange rate. value must not be negative and a margin must be below 1. Requires the Cost Plus feature (Enterprise).
Extends PriceAdjustmentBase.
| Field | Type | Required | Description |
|---|---|---|---|
type |
costplus |
Yes | — |
basis |
amount | percent |
Yes | — |
mode |
markup | margin |
No | Read only when basis is percent; defaults to markup. |
value |
number | Yes | Currency amount above cost for amount; fraction of cost for percent. |
round |
boolean | No | Round the derived price to 2 decimals (default true); false keeps 5 decimals. |
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 | CostPlusAdjustment | VolumeAdjustment | TableEnumAdjustment | TableRangeAdjustment | VariantAdjustment
SearchPriceBookPricedProductsPrice
Section titled “SearchPriceBookPricedProductsPrice”| Field | Type | Required | Description |
|---|---|---|---|
listPrice |
number | Yes | — |
standardPrice |
number | Yes | — |
adjustment |
PriceBookEntryAdjustment | No | — |
SearchPriceBookPricedProductsPriceInfo
Section titled “SearchPriceBookPricedProductsPriceInfo”| Field | Type | Required | Description |
|---|---|---|---|
productId |
string | Yes | — |
allowUnitPriceEditing |
boolean | Yes | Entry-level flag from the price book record (not per-currency). |
properties |
map of string to string | Yes | — |
prices |
map of string to SearchPriceBookPricedProductsPrice | Yes | Price details per currency. Keyed by ISO 4217 currency code (for example USD, EUR). |
SearchPriceBookPricedProductsResponse
Section titled “SearchPriceBookPricedProductsResponse”| Field | Type | Required | Description |
|---|---|---|---|
total |
number | Yes | — |
results |
SearchPriceBookPricedProductsPriceInfo[] | Yes | — |
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.