GET https://api.secure.quotivity.com/v1/bundles/{bundleId}/options/{optionId}
Retrieves a bundle option with its priced products.
Send your API key in the x-api-key header. See Generating API keys.
| Name |
Type |
Required |
Description |
bundleId |
string |
Yes |
— |
optionId |
string |
Yes |
— |
| Name |
Type |
Required |
Description |
startKey |
string |
No |
Cursor for pagination of products |
limit |
string |
No |
— |
| Status |
Body |
Description |
200 |
GetBundleOptionResponse |
Successfully retrieved bundle option |
400 |
— |
Bundle option does not belong to this bundle |
401 |
— |
Unauthorized |
500 |
— |
Internal Server Error |
| Field |
Type |
Required |
Description |
id |
string |
Yes |
— |
accountId |
string |
Yes |
— |
bundleId |
string |
Yes |
— |
name |
string |
Yes |
— |
description |
string |
No |
— |
priceBookId |
string |
Yes |
— |
displayOrder |
number |
Yes |
— |
configuration |
BundleOptionConfiguration |
Yes |
— |
| Field |
Type |
Required |
Description |
minCount |
number |
No |
— |
maxCount |
number |
No |
— |
defaultOptionProductId |
string |
No |
— |
| Field |
Type |
Required |
Description |
id |
string |
Yes |
— |
accountId |
string |
Yes |
— |
bundleId |
string |
Yes |
— |
optionId |
string |
Yes |
— |
productId |
string |
Yes |
— |
properties |
map of string to string |
Yes |
— |
configuration |
BundleProductConfiguration |
No |
— |
displayOrder |
number |
Yes |
— |
| Field |
Type |
Required |
Description |
minQuantity |
number |
No |
— |
maxQuantity |
number |
No |
— |
readonlyQuantity |
boolean |
No |
— |
Extends BundleOption.
| Field |
Type |
Required |
Description |
id |
string |
Yes |
— |
accountId |
string |
Yes |
— |
bundleId |
string |
Yes |
— |
name |
string |
Yes |
— |
description |
string |
No |
— |
priceBookId |
string |
Yes |
— |
displayOrder |
number |
Yes |
— |
configuration |
BundleOptionConfiguration |
Yes |
— |
products |
PricedBundleOptionProduct[] |
Yes |
— |
nextKey |
string |
No |
— |
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
Extends BundleOptionProduct.
| Field |
Type |
Required |
Description |
id |
string |
Yes |
— |
accountId |
string |
Yes |
— |
bundleId |
string |
Yes |
— |
optionId |
string |
Yes |
— |
productId |
string |
Yes |
— |
properties |
map of string to string |
Yes |
— |
configuration |
BundleProductConfiguration |
No |
— |
displayOrder |
number |
Yes |
— |
adjustments |
map of string to PriceBookEntryAdjustment |
Yes |
Price adjustments keyed by ISO 4217 currency code (for example USD, EUR). The key is the currency; the value carries the adjustment only. |
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. |
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. |
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 |
— |
