Skip to main content
GET
/
subscriptions
/
cp
/
api
/
bundle-discount-rules
List discount rules applicable to bundles
curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/bundle-discount-rules
[
  {
    "id": 123,
    "shop": "<string>",
    "name": "<string>",
    "discountName": "<string>",
    "description": "<string>",
    "customerIncludeTags": "<string>",
    "discountValue": 123,
    "products": "<string>",
    "variants": "<string>",
    "sequenceNo": 123,
    "settings": "<string>",
    "bundleProductId": 123,
    "bundleVariantId": "<string>",
    "productHandle": "<string>",
    "discountId": "<string>",
    "price": 123,
    "numberOfProducts": 123,
    "subscriptionBundlingEnabled": true,
    "subscriptionId": 123,
    "minProductCount": 123,
    "maxProductCount": 123,
    "uniqueRef": "<string>",
    "customRedirectURL": "<string>",
    "minOrderAmount": 123,
    "tieredDiscount": "<string>",
    "singleProductSettings": "<string>",
    "trackInventory": true,
    "minPrice": 123,
    "maxPrice": 123,
    "externalBuildABoxId": 123,
    "subTitle": "<string>",
    "freeShipping": true,
    "showBundleInProductPage": true,
    "combinedWithProductDiscount": true,
    "combinedWithShippingDiscount": true,
    "combinedWithOrderDiscount": true,
    "allowedTags": "<string>",
    "restrictTags": "<string>",
    "bundleHtml": "<string>",
    "discountedVariants": "<string>",
    "allowedCountries": "<string>",
    "internalName": "<string>",
    "sections": "<string>",
    "limitToUsePerCustomer": 123,
    "discountedVariantSelectionLimit": 123,
    "hideOneTimePurchase": true,
    "hideSubscriptionPurchase": true,
    "maxOrderAmount": 123,
    "collectionData": "<string>",
    "tag": "<string>",
    "variantSelectionLimit": 123,
    "enableSubscription": true,
    "subscribeTitle": "<string>",
    "subscribeSubtitle": "<string>",
    "subscriptionPreselected": true,
    "announcementBarMessage": "<string>",
    "automaticDiscountNodeId": "<string>",
    "recurringCycleLimit": 123,
    "automaticShippingDiscountNodeId": "<string>",
    "scheduledBundleRule": true,
    "style": "<string>",
    "labels": "<string>",
    "upsells": "<string>",
    "enableVolumeDiscountUpsell": true,
    "combos": "<string>",
    "subscriptionBundleLink": "<string>",
    "hasOptionChanges": true,
    "hasProductChanges": true,
    "enableAnnouncementBar": true,
    "topBarFreeShippingMessage": "<string>",
    "topBarPercentDiscountMessage": "<string>",
    "topBarFixedDiscountMessage": "<string>",
    "topBarDiscountRequiredQuantityMessage": "<string>",
    "topBarDiscountRequiredAmountMessage": "<string>",
    "topBarDiscountUnlockTitlePrefix": "<string>",
    "enableSequentialProductLoading": true,
    "sequentialProductsPerBatch": 123,
    "showPricesWithoutDecimal": true,
    "showClassicBundleWidgetInChildProduct": true,
    "showUnitPrice": true,
    "unitLabel": "<string>",
    "includedSubscriptionPlans": "<string>",
    "excludeSubscriptionPlans": "<string>",
    "showPriceOfChosenProductsOnly": true,
    "showPriceWithSubscriptionPrice": true,
    "borderRadius": 123,
    "cardGap": 123,
    "totalVisitor": 123,
    "totalOrderValue": 123,
    "averageOrderValue": 123,
    "conversionRate": 123,
    "cardBackgroundColor": "<string>",
    "cardBorderColor": "<string>",
    "cardHoverColor": "<string>",
    "selectedCardBackgroundColor": "<string>",
    "selectedCardBorderColor": "<string>",
    "blockTitleColor": "<string>",
    "tierTitleColor": "<string>",
    "tierSubTitleColor": "<string>",
    "tierPriceColor": "<string>",
    "tierFullPriceColor": "<string>",
    "saveBadgeBackgroundColor": "<string>",
    "saveBadgeTextColor": "<string>",
    "badgesBackgroundColor": "<string>",
    "badgesTextColor": "<string>",
    "tierFreeGiftBackgroundColor": "<string>",
    "tierFreeGiftTextColor": "<string>",
    "blockTitleFontSize": 123,
    "blockTitleFontStyle": "<string>",
    "tierTitleFontSize": 123,
    "tierTitleFontStyle": "<string>",
    "tierSubTitleFontSize": 123,
    "tierSubTitleFontStyle": "<string>",
    "saveBadgeFontSize": 123,
    "saveBadgeFontStyle": "<string>",
    "tierPriceFontSize": 123,
    "tierPriceFontStyle": "<string>",
    "tierFullPriceFontSize": 123,
    "tierFullPriceFontStyle": "<string>",
    "tierUnitLabelFontSize": 123,
    "tierUnitLabelFontStyle": "<string>",
    "tierFreeGiftTitleFontSize": 123,
    "tierFreeGiftTitleFontStyle": "<string>",
    "tierFreeGiftPriceFontSize": 123,
    "tierFreeGiftPriceFontStyle": "<string>",
    "subscriptionTitleTextColor": "<string>",
    "subscriptionSubTitleTextColor": "<string>",
    "otherProductsProductTitleColor": "<string>",
    "otherProductsButtonBackgroundColor": "<string>",
    "otherProductsButtonTextColor": "<string>",
    "otherProductsModalOverlayColor": "<string>",
    "otherProductsModalHeadingLabelColor": "<string>",
    "otherProductsModalProductTitleColor": "<string>",
    "otherProductsModalPriceColor": "<string>",
    "otherProductsModalFullPriceColor": "<string>",
    "otherProductsModalButtonBackgroundColor": "<string>",
    "otherProductsModalButtonTextColor": "<string>",
    "subscriptionTitleFontSize": 123,
    "subscriptionSubTitleFontSize": 123,
    "otherProductsImageSize": 123,
    "otherProductsProductTitleSize": 123,
    "otherProductsModalImageSize": 123,
    "otherProductsModalProductTitleTextSize": 123,
    "otherProductsModalProductPriceTextSize": 123,
    "oneTimeTitle": "<string>",
    "oneTimeSubtitle": "<string>",
    "otherProductsModalSubtitleLabel": "<string>",
    "headingTextColor": "<string>",
    "buttonBackgroundColor": "<string>",
    "productCardBackgroundColor": "<string>",
    "bundlePageBackgroundColor": "<string>",
    "disabledTextColor": "<string>",
    "fieldDisabledBackgroundColor": "<string>",
    "primaryDisabledTextColor": "<string>",
    "primaryDisabledColor": "<string>",
    "primaryHoverColor": "<string>",
    "secondaryTextColor": "<string>",
    "primaryTextColor": "<string>",
    "primaryColor": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - */*

OK

id
integer<int64>
shop
string
name
string
discountName
string
description
string
status
enum<string>
Available options:
ACTIVE,
PAUSED,
DRAFT
customerIncludeTags
string
discountType
enum<string>
Available options:
PERCENTAGE,
FIXED_AMOUNT,
FIXED_BUNDLE_AMOUNT,
TIERED_DISCOUNT,
NO_DISCOUNT,
FREE_GIFT
discountValue
number<double>
products
string
variants
string
sequenceNo
integer<int32>
bundleType
enum<string>
Available options:
MIX_AND_MATCH,
CLASSIC,
INFINITE,
CUSTOMIZE_BUNDLE,
CLASSIC_BUILD_A_BOX,
SINGLE_PRODUCT_BUILD_A_BOX,
VOLUME_DISCOUNT,
DISCOUNTED_PRICING,
SHIPPING_DISCOUNT,
BUY_X_GET_Y,
SECTIONED_BUNDLE,
COMBO_BUNDLE
settings
string
bundleProductId
integer<int64>
bundleVariantId
string
productHandle
string
discountId
string
price
number<double>
numberOfProducts
integer<int32>
subscriptionBundlingEnabled
boolean
subscriptionId
integer<int64>
minProductCount
integer<int32>
maxProductCount
integer<int32>
uniqueRef
string
bundleRedirect
enum<string>
Available options:
CART,
CHECKOUT,
CUSTOM,
NONE
customRedirectURL
string
minOrderAmount
number<double>
tieredDiscount
string
productViewStyle
enum<string>
Available options:
QUICK_ADD,
VIEW_DETAILS
singleProductSettings
string
trackInventory
boolean
sellingPlanType
enum<string>
Available options:
BUNDLE_LEVEL,
PRODUCT_LEVEL
clearCart
enum<string>
Available options:
DEFAULT,
ENABLED,
DISABLED
minPrice
number<double>
maxPrice
number<double>
externalBuildABoxId
integer<int64>
variantVisibilityType
enum<string>
Available options:
SHOW_VARIANTS_AS_INDIVIDUAL,
SHOW_VARIANTS_AS_OPTIONS
subTitle
string
freeShipping
boolean
themeType
enum<string>
Available options:
THEME_ONE,
THEME_TWO
showBundleInProductPage
boolean
combinedWithProductDiscount
boolean
combinedWithShippingDiscount
boolean
combinedWithOrderDiscount
boolean
allowedTags
string
restrictTags
string
selectionType
enum<string>
Available options:
FIXED,
FLEXIBLE
bundleHtml
string
discountedVariants
string
allowedCountries
string
appliesOn
enum<string>
Available options:
PRODUCT,
COLLECTION,
BOTH,
ONE_TIME,
SUBSCRIPTION
purchaseRequirement
enum<string>
Available options:
MINIMUM_AMOUNT,
MINIMUM_QUANTITY,
NO_REQUIREMENT
productDiscountType
enum<string>
Available options:
SELECTED_PRODUCT,
EACH_PRODUCT
countrySelectionType
enum<string>
Available options:
ALL_COUNTRY,
SELECTED_COUNTRY
discountApplyApproach
enum<string>
Available options:
SHOPIFY_DISCOUNT_FUNCTION,
SHOPIFY_DISCOUNT_API
discountedProductChooseType
enum<string>
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
internalName
string
sections
string
limitToUsePerCustomer
integer<int32>
discountedVariantSelectionLimit
integer<int32>
hideOneTimePurchase
boolean
hideSubscriptionPurchase
boolean
maxOrderAmount
number<double>
collectionData
string
productSelectionType
enum<string>
Available options:
PRODUCT,
COLLECTION
tag
string
productChooseType
enum<string>
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
variantSelectionLimit
integer<int32>
discountTargetType
enum<string>
Available options:
PRODUCT,
VARIANT,
ANY
enableSubscription
boolean
subscriptionWidgetPosition
enum<string>
Available options:
ABOVE,
BELOW
subscribeTitle
string
subscribeSubtitle
string
subscriptionPreselected
boolean
getYAppliesOn
enum<string>
Available options:
PRODUCT,
COLLECTION,
BOTH,
ONE_TIME,
SUBSCRIPTION
announcementBarMessage
string
automaticDiscountNodeId
string
recurringCycleLimit
integer<int32>
automaticShippingDiscountNodeId
string
scheduledBundleRule
boolean
bundleSubType
enum<string>
Available options:
BUY_X_GET_Y
discountAppliesOn
enum<string>
Available options:
PER_QUANTITY,
PER_ORDER,
PER_LINE_ITEM
layoutType
enum<string>
Available options:
LAYOUT_ONE,
LAYOUT_TWO,
LAYOUT_THREE,
LAYOUT_FOUR
style
string
labels
string
upsells
string
enableVolumeDiscountUpsell
boolean
combos
string
hasOptionChanges
boolean
hasProductChanges
boolean
enableAnnouncementBar
boolean
topBarFreeShippingMessage
string
topBarPercentDiscountMessage
string
topBarFixedDiscountMessage
string
topBarDiscountRequiredQuantityMessage
string
topBarDiscountRequiredAmountMessage
string
topBarDiscountUnlockTitlePrefix
string
enableSequentialProductLoading
boolean
sequentialProductsPerBatch
integer<int32>
showPricesWithoutDecimal
boolean
showClassicBundleWidgetInChildProduct
boolean
showUnitPrice
boolean
unitLabel
string
includedSubscriptionPlans
string
excludeSubscriptionPlans
string
showPriceOfChosenProductsOnly
boolean
showPriceWithSubscriptionPrice
boolean
perRowItem
enum<string>
Available options:
TWO,
THREE
borderRadius
integer<int32>
cardGap
integer<int32>
totalVisitor
integer<int64>
totalOrderValue
number<double>
averageOrderValue
number<double>
conversionRate
integer<int64>
cardBackgroundColor
string
cardBorderColor
string
cardHoverColor
string
selectedCardBackgroundColor
string
selectedCardBorderColor
string
blockTitleColor
string
tierTitleColor
string
tierSubTitleColor
string
tierPriceColor
string
tierFullPriceColor
string
saveBadgeBackgroundColor
string
saveBadgeTextColor
string
badgesBackgroundColor
string
badgesTextColor
string
tierFreeGiftBackgroundColor
string
tierFreeGiftTextColor
string
blockTitleFontSize
integer<int32>
blockTitleFontStyle
string
tierTitleFontSize
integer<int32>
tierTitleFontStyle
string
tierSubTitleFontSize
integer<int32>
tierSubTitleFontStyle
string
saveBadgeFontSize
integer<int32>
saveBadgeFontStyle
string
tierPriceFontSize
integer<int32>
tierPriceFontStyle
string
tierFullPriceFontSize
integer<int32>
tierFullPriceFontStyle
string
tierUnitLabelFontSize
integer<int32>
tierUnitLabelFontStyle
string
tierFreeGiftTitleFontSize
integer<int32>
tierFreeGiftTitleFontStyle
string
tierFreeGiftPriceFontSize
integer<int32>
tierFreeGiftPriceFontStyle
string
subscriptionTitleTextColor
string
subscriptionSubTitleTextColor
string
otherProductsProductTitleColor
string
otherProductsButtonBackgroundColor
string
otherProductsButtonTextColor
string
otherProductsModalOverlayColor
string
otherProductsModalHeadingLabelColor
string
otherProductsModalProductTitleColor
string
otherProductsModalPriceColor
string
otherProductsModalFullPriceColor
string
otherProductsModalButtonBackgroundColor
string
otherProductsModalButtonTextColor
string
subscriptionTitleFontSize
integer<int32>
subscriptionSubTitleFontSize
integer<int32>
otherProductsImageSize
integer<int32>
otherProductsProductTitleSize
integer<int32>
otherProductsModalImageSize
integer<int32>
otherProductsModalProductTitleTextSize
integer<int32>
otherProductsModalProductPriceTextSize
integer<int32>
dedicatedSubscriptionLayout
enum<string>
Available options:
LAYOUT_ONE,
LAYOUT_TWO,
LAYOUT_THREE
badgesStyles
enum<string>
Available options:
TRIANGLES,
NORMAL
oneTimeTitle
string
oneTimeSubtitle
string
otherProductsModalSubtitleLabel
string
headingTextColor
string
buttonBackgroundColor
string
productCardBackgroundColor
string
bundlePageBackgroundColor
string
disabledTextColor
string
fieldDisabledBackgroundColor
string
primaryDisabledTextColor
string
primaryDisabledColor
string
primaryHoverColor
string
secondaryTextColor
string
primaryTextColor
string
primaryColor
string