Skip to content

Search Price Book Priced Products

GET https://api.secure.quotivity.com/v1/pricebooks/{priceBookId}/pricedProducts

Search products already in a price book and populates their prices.

Send your API key in the x-api-key header. See Generating API keys.

Name Type Required Description
priceBookId string Yes
Name Type Required Description
searchKeyword string No
limit string No
after string No
amount string No Reserved for future use.
Status Body Description
200 SearchPriceBookPricedProductsResponse Search results
401 Unauthorized
500 Internal Server Error

Extends PriceAdjustmentBase.

Field Type Required Description
type override Yes
amount number Yes

Extends PriceAdjustmentBase.

Field Type Required Description
type percent Yes
amount number Yes
Field Type Required Description
type string Yes

Type: OverrideAdjustment | PercentAdjustment | VolumeAdjustment | TableEnumAdjustment | TableRangeAdjustment | VariantAdjustment

Field Type Required Description
listPrice number Yes
standardPrice number Yes
adjustment PriceBookEntryAdjustment No
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).
Field Type Required Description
total number Yes
results SearchPriceBookPricedProductsPriceInfo[] Yes

Extends PriceAdjustmentBase.

Field Type Required Description
type enum Yes
property string Yes
values object[] Yes

Extends PriceAdjustmentBase.

Field Type Required Description
type range Yes
property string Yes
values object[] Yes

Extends PriceAdjustmentBase.

Field Type Required Description
type variant Yes
values object[] Yes

Extends PriceAdjustmentBase.

Field Type Required Description
type volume Yes
tiers object[] Yes