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
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/bundle-discount-rules"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/bundle-discount-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/subscriptions/cp/api/bundle-discount-rules';
const options = {method: 'GET'};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/bundle-discount-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://www.myshop.com/apps/subscriptions/cp/api/bundle-discount-rules"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://www.myshop.com/apps/subscriptions/cp/api/bundle-discount-rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

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

Response

200 - */*

OK

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