Skip to main content
GET
/
api
/
external
/
bundle-rules
Get all bundle rules
curl --request GET \
  --url https://bundles-admin.appstle.com/api/external/bundle-rules
import requests

url = "https://bundles-admin.appstle.com/api/external/bundle-rules"

response = requests.get(url)

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

fetch('https://bundles-admin.appstle.com/api/external/bundle-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://bundles-admin.appstle.com/api/external/bundle-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://bundles-admin.appstle.com/api/external/bundle-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://bundles-admin.appstle.com/api/external/bundle-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://bundles-admin.appstle.com/api/external/bundle-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
[
  {
    "allowMixAndMatchBelowMinimumTier": true,
    "allowedCountries": "<string>",
    "allowedTags": "<string>",
    "announcementBarMessage": "<string>",
    "autofillNotChosenItems": true,
    "automaticDiscountNodeId": "<string>",
    "automaticShippingDiscountNodeId": "<string>",
    "averageOrderValue": 123,
    "badgesBackgroundColor": "<string>",
    "badgesTextColor": "<string>",
    "blockTitleColor": "<string>",
    "blockTitleFontSize": 123,
    "blockTitleFontStyle": "<string>",
    "borderRadius": 123,
    "breadCrumbSelectSectionIconUrl": "<string>",
    "bundleActiveFrom": "2023-11-07T05:31:56Z",
    "bundleActiveTo": "2023-11-07T05:31:56Z",
    "bundleHtml": "<string>",
    "bundlePageBackgroundColor": "<string>",
    "bundleProductId": 123,
    "bundleVariantId": "<string>",
    "buttonBackgroundColor": "<string>",
    "buttonPriceSelector": "<string>",
    "cardBackgroundColor": "<string>",
    "cardBorderColor": "<string>",
    "cardGap": 123,
    "cardHoverColor": "<string>",
    "collectionData": "<string>",
    "combinedWithOrderDiscount": true,
    "combinedWithProductDiscount": true,
    "combinedWithShippingDiscount": true,
    "comboProductFullPriceFontSize": 123,
    "comboProductFullPriceFontStyle": "<string>",
    "comboProductPriceFontSize": 123,
    "comboProductPriceFontStyle": "<string>",
    "comboProductTitleFontSize": 123,
    "comboProductTitleFontStyle": "<string>",
    "combos": "<string>",
    "compareAtPriceSelector": "<string>",
    "conversionRate": 123,
    "customRedirectURL": "<string>",
    "customerIncludeTags": "<string>",
    "defaultVariants": "<string>",
    "description": "<string>",
    "disableCartLineForSelectedBundleItems": true,
    "disableHighestTierPreference": true,
    "disableProductDescription": true,
    "disableQuantityRestrictedSection": true,
    "disableScrollingToBundle": true,
    "disableTierRestriction": true,
    "disabledTextColor": "<string>",
    "discountBadgeSelector": "<string>",
    "discountId": "<string>",
    "discountName": "<string>",
    "discountValue": 123,
    "discountedVariantSelectionLimit": 123,
    "discountedVariants": "<string>",
    "enableAnnouncementBar": true,
    "enableCompactMixAndMatchVariants": true,
    "enableDedicatedAddToCartButton": true,
    "enableMixAndMatchNativeAddToCart": true,
    "enableOrderDiscountClass": true,
    "enableProgressiveGifts": true,
    "enableSequentialProductLoading": true,
    "enableSubscription": true,
    "enableTriggerFreeGiftWithoutWidget": true,
    "enableVolumeDiscountMixAndMatch": true,
    "enableVolumeDiscountTierRestriction": true,
    "enableVolumeDiscountUpsell": true,
    "excludeSubscriptionPlans": "<string>",
    "externalBuildABoxId": 123,
    "fieldDisabledBackgroundColor": "<string>",
    "fixedBundleProductPageAddToBundleButtonBackgroundColor": "<string>",
    "fixedBundleProductPageAddToBundleButtonTextColor": "<string>",
    "fixedBundleProductPageAddToBundleLabel": "<string>",
    "fixedBundleProductPageAddToCartLabel": "<string>",
    "fixedBundleProductPageAddingToCartLabel": "<string>",
    "fixedBundleProductPageAdditionalOrderNoteLabel": "<string>",
    "fixedBundleProductPageAllSetLabel": "<string>",
    "fixedBundleProductPageAllSetLabelColor": "<string>",
    "fixedBundleProductPageBorderRadius": 123,
    "fixedBundleProductPageBreakdownFreeBadgeBackgroundColor": "<string>",
    "fixedBundleProductPageBreakdownFreeBadgeTextColor": "<string>",
    "fixedBundleProductPageBreakdownLabel": "<string>",
    "fixedBundleProductPageBreakdownToggleFontSize": 123,
    "fixedBundleProductPageBreakdownToggleFontStyle": "<string>",
    "fixedBundleProductPageBreakdownYouPayColor": "<string>",
    "fixedBundleProductPageCardBackgroundColor": "<string>",
    "fixedBundleProductPageCardBorderColor": "<string>",
    "fixedBundleProductPageCardPadding": 123,
    "fixedBundleProductPageCheckoutButtonBackgroundColor": "<string>",
    "fixedBundleProductPageCheckoutButtonFontSize": 123,
    "fixedBundleProductPageCheckoutButtonFontStyle": "<string>",
    "fixedBundleProductPageCheckoutButtonTextColor": "<string>",
    "fixedBundleProductPageChildCompareAtPriceColor": "<string>",
    "fixedBundleProductPageChildFixedQtyBackgroundColor": "<string>",
    "fixedBundleProductPageChildPriceFontSize": 123,
    "fixedBundleProductPageChildPriceFontStyle": "<string>",
    "fixedBundleProductPageChildTitleColor": "<string>",
    "fixedBundleProductPageChildTitleFontSize": 123,
    "fixedBundleProductPageChildTitleFontStyle": "<string>",
    "fixedBundleProductPageChildVariantColor": "<string>",
    "fixedBundleProductPageChooseAssociatedProductsLabel": "<string>",
    "fixedBundleProductPageChooseSourceProductLabel": "<string>",
    "fixedBundleProductPageContentsSubtitleColor": "<string>",
    "fixedBundleProductPageContentsTitleColor": "<string>",
    "fixedBundleProductPageContentsTitleFontSize": 123,
    "fixedBundleProductPageContentsTitleFontStyle": "<string>",
    "fixedBundleProductPageCurrentlyOutOfStockTooltip": "<string>",
    "fixedBundleProductPageDetailsMediaBackgroundColor": "<string>",
    "fixedBundleProductPageEmptyContentsLabel": "<string>",
    "fixedBundleProductPageFixedContentsTitle": "<string>",
    "fixedBundleProductPageFlexibleContentsTitle": "<string>",
    "fixedBundleProductPageFooterPriceColor": "<string>",
    "fixedBundleProductPageFooterPriceFontSize": 123,
    "fixedBundleProductPageFooterPriceFontStyle": "<string>",
    "fixedBundleProductPageFreeLabel": "<string>",
    "fixedBundleProductPageItemsInsideLabel": "<string>",
    "fixedBundleProductPageLowStockLabel": "<string>",
    "fixedBundleProductPageLowStockTooltip": "<string>",
    "fixedBundleProductPageMaximumQuantityLabel": "<string>",
    "fixedBundleProductPageMinimumQuantityLabel": "<string>",
    "fixedBundleProductPageNotEligibleLabel": "<string>",
    "fixedBundleProductPageOrderNoteLabel": "<string>",
    "fixedBundleProductPageOutOfStockCheckoutMessage": "<string>",
    "fixedBundleProductPageOutOfStockLabel": "<string>",
    "fixedBundleProductPageOutOfStockTooltip": "<string>",
    "fixedBundleProductPageParentCompareAtPriceColor": "<string>",
    "fixedBundleProductPageParentEyebrowColor": "<string>",
    "fixedBundleProductPageParentPriceColor": "<string>",
    "fixedBundleProductPageParentPriceFontSize": 123,
    "fixedBundleProductPageParentPriceFontStyle": "<string>",
    "fixedBundleProductPageParentTitleColor": "<string>",
    "fixedBundleProductPageParentTitleFontSize": 123,
    "fixedBundleProductPageParentTitleFontStyle": "<string>",
    "fixedBundleProductPagePickAnyLabel": "<string>",
    "fixedBundleProductPagePickMaxLabel": "<string>",
    "fixedBundleProductPagePickMinLabel": "<string>",
    "fixedBundleProductPagePickRangeLabel": "<string>",
    "fixedBundleProductPagePriceBreakdownTitle": "<string>",
    "fixedBundleProductPageProgressBarFillColor": "<string>",
    "fixedBundleProductPageProgressBarTrackColor": "<string>",
    "fixedBundleProductPageProgressLabel": "<string>",
    "fixedBundleProductPagePurchaseOptionBorderColor": "<string>",
    "fixedBundleProductPagePurchaseOptionLabel": "<string>",
    "fixedBundleProductPagePurchaseOptionLabelColor": "<string>",
    "fixedBundleProductPagePurchaseOptionSelectedColor": "<string>",
    "fixedBundleProductPageRequiredLoginLabel": "<string>",
    "fixedBundleProductPageSelectOptionLabel": "<string>",
    "fixedBundleProductPageSubscriptionSaveLabel": "<string>",
    "fixedBundleProductPageTotalValueLabel": "<string>",
    "fixedBundleProductPageValidationMessageColor": "<string>",
    "fixedBundleProductPageYouPayLabel": "<string>",
    "fixedBundleProductPageYourBundleLabel": "<string>",
    "freeShipping": true,
    "hasOptionChanges": true,
    "hasProductChanges": true,
    "headingTextColor": "<string>",
    "hideOneTimePurchase": true,
    "hideOutOfStockVariants": true,
    "hideQuantitySelector": true,
    "hideSubscriptionPurchase": true,
    "id": 123,
    "includedSubscriptionPlans": "<string>",
    "initialVisibleMixAndMatchVariantCount": 123,
    "insufficientStockLabel": "<string>",
    "internalName": "<string>",
    "labels": "<string>",
    "limitToUsePerCustomer": 123,
    "maxOrderAmount": 123,
    "maxPrice": 123,
    "maxProductCount": 123,
    "minOrderAmount": 123,
    "minPrice": 123,
    "minProductCount": 123,
    "mixAndMatchAddButtonLabel": "<string>",
    "mixAndMatchAddToCartLabel": "<string>",
    "mixAndMatchAddedItemsLabel": "<string>",
    "mixAndMatchGiftBadgeLabel": "<string>",
    "mixAndMatchLockedLabel": "<string>",
    "mixAndMatchNoProductSelectedLabel": "<string>",
    "mixAndMatchNoProductsAvailableLabel": "<string>",
    "mixAndMatchSeeAllLabel": "<string>",
    "mixAndMatchTierDiscountLabel": "<string>",
    "mixAndMatchTierQuantityLabel": "<string>",
    "mixAndMatchUnlockedLabel": "<string>",
    "mixAndMatchUpsellBadgeLabel": "<string>",
    "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,
    "priceSelector": "<string>",
    "primaryColor": "<string>",
    "primaryDisabledColor": "<string>",
    "primaryDisabledTextColor": "<string>",
    "primaryHoverColor": "<string>",
    "primaryTextColor": "<string>",
    "productCardBackgroundColor": "<string>",
    "productFilterConfig": "<string>",
    "productHandle": "<string>",
    "products": "<string>",
    "progressiveGift": "<string>",
    "recurringCycleLimit": 123,
    "removeBundlePropertiesWhenNoDiscount": true,
    "restrictTags": "<string>",
    "ruleUpsellSubTitleFontSize": 123,
    "ruleUpsellSubTitleTextColor": "<string>",
    "ruleUpsellTitleFontSize": 123,
    "ruleUpsellTitleTextColor": "<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>",
    "showAdditionalNoteInput": true,
    "showBundleInProductPage": true,
    "showClassicBundleWidgetInChildProduct": true,
    "showComboBundleWidgetInComboProduct": true,
    "showCompareAtPrice": true,
    "showPriceOfChosenProductsOnly": true,
    "showPriceWithSubscriptionPrice": true,
    "showPricesWithoutDecimal": true,
    "showSectionedBundleDiscountProgressBar": true,
    "showSellingPlanDescription": 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>",
    "tierUpsellBackgroundColor": "<string>",
    "tierUpsellSubTitleFontSize": 123,
    "tierUpsellSubTitleTextColor": "<string>",
    "tierUpsellTitleFontSize": 123,
    "tierUpsellTitleTextColor": "<string>",
    "tieredDiscount": "<string>",
    "topBarDiscountRequiredAmountMessage": "<string>",
    "topBarDiscountRequiredQuantityMessage": "<string>",
    "topBarDiscountUnlockTitlePrefix": "<string>",
    "topBarFixedDiscountMessage": "<string>",
    "topBarFreeShippingMessage": "<string>",
    "topBarPercentDiscountMessage": "<string>",
    "totalOrderValue": 123,
    "totalVisitor": 123,
    "trackInventory": true,
    "translations": "<string>",
    "uniqueRef": "<string>",
    "unitLabel": "<string>",
    "updateThemeProductPrice": true,
    "upsellProductSelectionMode": "<string>",
    "upsellSubTitle": "<string>",
    "upsellTitle": "<string>",
    "upsells": "<string>",
    "useOriginalPriceForBuyXTotal": true,
    "validateInventoryQuantity": true,
    "variantSelectionLimit": 123,
    "variants": "<string>",
    "volumeAmountDiscountQuantityRewardsLabel": "<string>",
    "volumeAmountDiscountSaveRewardsLabel": "<string>",
    "volumeAmountDiscountSpentAmountRewardsLabel": "<string>",
    "volumeDiscountQuantityRewardsLabel": "<string>",
    "volumeDiscountSaveRewardsLabel": "<string>",
    "volumeDiscountSpentAmountRewardsLabel": "<string>"
  }
]

Query Parameters

id.greaterThan
integer<int64>
id.lessThan
integer<int64>
id.greaterThanOrEqual
integer<int64>
id.lessThanOrEqual
integer<int64>
id.equals
integer<int64>
id.notEquals
integer<int64>
id.specified
boolean
id.in
integer<int64>[]
id.notIn
integer<int64>[]
shop.contains
string
shop.doesNotContain
string
shop.equals
string
shop.notEquals
string
shop.specified
boolean
shop.in
string[]
shop.notIn
string[]
name.contains
string
name.doesNotContain
string
name.equals
string
name.notEquals
string
name.specified
boolean
name.in
string[]
name.notIn
string[]
description.contains
string
description.doesNotContain
string
description.equals
string
description.notEquals
string
description.specified
boolean
description.in
string[]
description.notIn
string[]
status.equals
enum<string>
Available options:
ACTIVE,
DRAFT
status.notEquals
enum<string>
Available options:
ACTIVE,
DRAFT
status.specified
boolean
status.in
enum<string>[]
Available options:
ACTIVE,
DRAFT
status.notIn
enum<string>[]
Available options:
ACTIVE,
DRAFT
customerIncludeTags.contains
string
customerIncludeTags.doesNotContain
string
customerIncludeTags.equals
string
customerIncludeTags.notEquals
string
customerIncludeTags.specified
boolean
customerIncludeTags.in
string[]
customerIncludeTags.notIn
string[]
discountType.equals
enum<string>
Available options:
PERCENTAGE,
FIXED_AMOUNT,
FIXED_BUNDLE_AMOUNT,
TIERED_DISCOUNT,
NO_DISCOUNT,
FREE_GIFT
discountType.notEquals
enum<string>
Available options:
PERCENTAGE,
FIXED_AMOUNT,
FIXED_BUNDLE_AMOUNT,
TIERED_DISCOUNT,
NO_DISCOUNT,
FREE_GIFT
discountType.specified
boolean
discountType.in
enum<string>[]
Available options:
PERCENTAGE,
FIXED_AMOUNT,
FIXED_BUNDLE_AMOUNT,
TIERED_DISCOUNT,
NO_DISCOUNT,
FREE_GIFT
discountType.notIn
enum<string>[]
Available options:
PERCENTAGE,
FIXED_AMOUNT,
FIXED_BUNDLE_AMOUNT,
TIERED_DISCOUNT,
NO_DISCOUNT,
FREE_GIFT
discountValue.greaterThan
number<double>
discountValue.lessThan
number<double>
discountValue.greaterThanOrEqual
number<double>
discountValue.lessThanOrEqual
number<double>
discountValue.equals
number<double>
discountValue.notEquals
number<double>
discountValue.specified
boolean
discountValue.in
number<double>[]
discountValue.notIn
number<double>[]
sequenceNo.greaterThan
integer<int32>
sequenceNo.lessThan
integer<int32>
sequenceNo.greaterThanOrEqual
integer<int32>
sequenceNo.lessThanOrEqual
integer<int32>
sequenceNo.equals
integer<int32>
sequenceNo.notEquals
integer<int32>
sequenceNo.specified
boolean
sequenceNo.in
integer<int32>[]
sequenceNo.notIn
integer<int32>[]
bundleType.equals
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
bundleType.notEquals
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
bundleType.specified
boolean
bundleType.in
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
bundleType.notIn
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
bundleProductId.greaterThan
integer<int64>
bundleProductId.lessThan
integer<int64>
bundleProductId.greaterThanOrEqual
integer<int64>
bundleProductId.lessThanOrEqual
integer<int64>
bundleProductId.equals
integer<int64>
bundleProductId.notEquals
integer<int64>
bundleProductId.specified
boolean
bundleProductId.in
integer<int64>[]
bundleProductId.notIn
integer<int64>[]
bundleVariantId.contains
string
bundleVariantId.doesNotContain
string
bundleVariantId.equals
string
bundleVariantId.notEquals
string
bundleVariantId.specified
boolean
bundleVariantId.in
string[]
bundleVariantId.notIn
string[]
productHandle.contains
string
productHandle.doesNotContain
string
productHandle.equals
string
productHandle.notEquals
string
productHandle.specified
boolean
productHandle.in
string[]
productHandle.notIn
string[]
discountId.contains
string
discountId.doesNotContain
string
discountId.equals
string
discountId.notEquals
string
discountId.specified
boolean
discountId.in
string[]
discountId.notIn
string[]
price.greaterThan
number<double>
price.lessThan
number<double>
price.greaterThanOrEqual
number<double>
price.lessThanOrEqual
number<double>
price.equals
number<double>
price.notEquals
number<double>
price.specified
boolean
price.in
number<double>[]
price.notIn
number<double>[]
numberOfProducts.greaterThan
integer<int32>
numberOfProducts.lessThan
integer<int32>
numberOfProducts.greaterThanOrEqual
integer<int32>
numberOfProducts.lessThanOrEqual
integer<int32>
numberOfProducts.equals
integer<int32>
numberOfProducts.notEquals
integer<int32>
numberOfProducts.specified
boolean
numberOfProducts.in
integer<int32>[]
numberOfProducts.notIn
integer<int32>[]
subscriptionBundlingEnabled.equals
boolean
subscriptionBundlingEnabled.notEquals
boolean
subscriptionBundlingEnabled.specified
boolean
subscriptionBundlingEnabled.in
boolean[]
subscriptionBundlingEnabled.notIn
boolean[]
subscriptionId.greaterThan
integer<int64>
subscriptionId.lessThan
integer<int64>
subscriptionId.greaterThanOrEqual
integer<int64>
subscriptionId.lessThanOrEqual
integer<int64>
subscriptionId.equals
integer<int64>
subscriptionId.notEquals
integer<int64>
subscriptionId.specified
boolean
subscriptionId.in
integer<int64>[]
subscriptionId.notIn
integer<int64>[]
minProductCount.greaterThan
integer<int32>
minProductCount.lessThan
integer<int32>
minProductCount.greaterThanOrEqual
integer<int32>
minProductCount.lessThanOrEqual
integer<int32>
minProductCount.equals
integer<int32>
minProductCount.notEquals
integer<int32>
minProductCount.specified
boolean
minProductCount.in
integer<int32>[]
minProductCount.notIn
integer<int32>[]
maxProductCount.greaterThan
integer<int32>
maxProductCount.lessThan
integer<int32>
maxProductCount.greaterThanOrEqual
integer<int32>
maxProductCount.lessThanOrEqual
integer<int32>
maxProductCount.equals
integer<int32>
maxProductCount.notEquals
integer<int32>
maxProductCount.specified
boolean
maxProductCount.in
integer<int32>[]
maxProductCount.notIn
integer<int32>[]
uniqueRef.contains
string
uniqueRef.doesNotContain
string
uniqueRef.equals
string
uniqueRef.notEquals
string
uniqueRef.specified
boolean
uniqueRef.in
string[]
uniqueRef.notIn
string[]
bundleRedirect.equals
enum<string>
Available options:
CART,
CHECKOUT,
CUSTOM,
NONE
bundleRedirect.notEquals
enum<string>
Available options:
CART,
CHECKOUT,
CUSTOM,
NONE
bundleRedirect.specified
boolean
bundleRedirect.in
enum<string>[]
Available options:
CART,
CHECKOUT,
CUSTOM,
NONE
bundleRedirect.notIn
enum<string>[]
Available options:
CART,
CHECKOUT,
CUSTOM,
NONE
customRedirectURL.contains
string
customRedirectURL.doesNotContain
string
customRedirectURL.equals
string
customRedirectURL.notEquals
string
customRedirectURL.specified
boolean
customRedirectURL.in
string[]
customRedirectURL.notIn
string[]
minOrderAmount.greaterThan
number<double>
minOrderAmount.lessThan
number<double>
minOrderAmount.greaterThanOrEqual
number<double>
minOrderAmount.lessThanOrEqual
number<double>
minOrderAmount.equals
number<double>
minOrderAmount.notEquals
number<double>
minOrderAmount.specified
boolean
minOrderAmount.in
number<double>[]
minOrderAmount.notIn
number<double>[]
productViewStyle.equals
enum<string>
Available options:
QUICK_ADD,
VIEW_DETAILS
productViewStyle.notEquals
enum<string>
Available options:
QUICK_ADD,
VIEW_DETAILS
productViewStyle.specified
boolean
productViewStyle.in
enum<string>[]
Available options:
QUICK_ADD,
VIEW_DETAILS
productViewStyle.notIn
enum<string>[]
Available options:
QUICK_ADD,
VIEW_DETAILS
trackInventory.equals
boolean
trackInventory.notEquals
boolean
trackInventory.specified
boolean
trackInventory.in
boolean[]
trackInventory.notIn
boolean[]
sellingPlanType.equals
enum<string>
Available options:
BUNDLE_LEVEL,
PRODUCT_LEVEL
sellingPlanType.notEquals
enum<string>
Available options:
BUNDLE_LEVEL,
PRODUCT_LEVEL
sellingPlanType.specified
boolean
sellingPlanType.in
enum<string>[]
Available options:
BUNDLE_LEVEL,
PRODUCT_LEVEL
sellingPlanType.notIn
enum<string>[]
Available options:
BUNDLE_LEVEL,
PRODUCT_LEVEL
clearCart.equals
enum<string>
Available options:
DEFAULT,
ENABLED,
DISABLED
clearCart.notEquals
enum<string>
Available options:
DEFAULT,
ENABLED,
DISABLED
clearCart.specified
boolean
clearCart.in
enum<string>[]
Available options:
DEFAULT,
ENABLED,
DISABLED
clearCart.notIn
enum<string>[]
Available options:
DEFAULT,
ENABLED,
DISABLED
minPrice.greaterThan
number<double>
minPrice.lessThan
number<double>
minPrice.greaterThanOrEqual
number<double>
minPrice.lessThanOrEqual
number<double>
minPrice.equals
number<double>
minPrice.notEquals
number<double>
minPrice.specified
boolean
minPrice.in
number<double>[]
minPrice.notIn
number<double>[]
maxPrice.greaterThan
number<double>
maxPrice.lessThan
number<double>
maxPrice.greaterThanOrEqual
number<double>
maxPrice.lessThanOrEqual
number<double>
maxPrice.equals
number<double>
maxPrice.notEquals
number<double>
maxPrice.specified
boolean
maxPrice.in
number<double>[]
maxPrice.notIn
number<double>[]
externalBuildABoxId.greaterThan
integer<int64>
externalBuildABoxId.lessThan
integer<int64>
externalBuildABoxId.greaterThanOrEqual
integer<int64>
externalBuildABoxId.lessThanOrEqual
integer<int64>
externalBuildABoxId.equals
integer<int64>
externalBuildABoxId.notEquals
integer<int64>
externalBuildABoxId.specified
boolean
externalBuildABoxId.in
integer<int64>[]
externalBuildABoxId.notIn
integer<int64>[]
variantVisibilityType.equals
enum<string>
Available options:
SHOW_VARIANTS_AS_INDIVIDUAL,
SHOW_VARIANTS_AS_OPTIONS
variantVisibilityType.notEquals
enum<string>
Available options:
SHOW_VARIANTS_AS_INDIVIDUAL,
SHOW_VARIANTS_AS_OPTIONS
variantVisibilityType.specified
boolean
variantVisibilityType.in
enum<string>[]
Available options:
SHOW_VARIANTS_AS_INDIVIDUAL,
SHOW_VARIANTS_AS_OPTIONS
variantVisibilityType.notIn
enum<string>[]
Available options:
SHOW_VARIANTS_AS_INDIVIDUAL,
SHOW_VARIANTS_AS_OPTIONS
subTitle.contains
string
subTitle.doesNotContain
string
subTitle.equals
string
subTitle.notEquals
string
subTitle.specified
boolean
subTitle.in
string[]
subTitle.notIn
string[]
freeShipping.equals
boolean
freeShipping.notEquals
boolean
freeShipping.specified
boolean
freeShipping.in
boolean[]
freeShipping.notIn
boolean[]
themeType.equals
enum<string>
Available options:
THEME_ONE,
THEME_TWO
themeType.notEquals
enum<string>
Available options:
THEME_ONE,
THEME_TWO
themeType.specified
boolean
themeType.in
enum<string>[]
Available options:
THEME_ONE,
THEME_TWO
themeType.notIn
enum<string>[]
Available options:
THEME_ONE,
THEME_TWO
showBundleInProductPage.equals
boolean
showBundleInProductPage.notEquals
boolean
showBundleInProductPage.specified
boolean
showBundleInProductPage.in
boolean[]
showBundleInProductPage.notIn
boolean[]
combinedWithProductDiscount.equals
boolean
combinedWithProductDiscount.notEquals
boolean
combinedWithProductDiscount.specified
boolean
combinedWithProductDiscount.in
boolean[]
combinedWithProductDiscount.notIn
boolean[]
combinedWithShippingDiscount.equals
boolean
combinedWithShippingDiscount.notEquals
boolean
combinedWithShippingDiscount.specified
boolean
combinedWithShippingDiscount.in
boolean[]
combinedWithShippingDiscount.notIn
boolean[]
combinedWithOrderDiscount.equals
boolean
combinedWithOrderDiscount.notEquals
boolean
combinedWithOrderDiscount.specified
boolean
combinedWithOrderDiscount.in
boolean[]
combinedWithOrderDiscount.notIn
boolean[]
selectionType.equals
enum<string>
Available options:
FIXED,
FLEXIBLE
selectionType.notEquals
enum<string>
Available options:
FIXED,
FLEXIBLE
selectionType.specified
boolean
selectionType.in
enum<string>[]
Available options:
FIXED,
FLEXIBLE
selectionType.notIn
enum<string>[]
Available options:
FIXED,
FLEXIBLE
allowedCountries.contains
string
allowedCountries.doesNotContain
string
allowedCountries.equals
string
allowedCountries.notEquals
string
allowedCountries.specified
boolean
allowedCountries.in
string[]
allowedCountries.notIn
string[]
appliesOn.equals
enum<string>
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
appliesOn.notEquals
enum<string>
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
appliesOn.specified
boolean
appliesOn.in
enum<string>[]
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
appliesOn.notIn
enum<string>[]
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
purchaseRequirement.equals
enum<string>
Available options:
MINIMUM_AMOUNT,
MINIMUM_QUANTITY,
NO_REQUIREMENT
purchaseRequirement.notEquals
enum<string>
Available options:
MINIMUM_AMOUNT,
MINIMUM_QUANTITY,
NO_REQUIREMENT
purchaseRequirement.specified
boolean
purchaseRequirement.in
enum<string>[]
Available options:
MINIMUM_AMOUNT,
MINIMUM_QUANTITY,
NO_REQUIREMENT
purchaseRequirement.notIn
enum<string>[]
Available options:
MINIMUM_AMOUNT,
MINIMUM_QUANTITY,
NO_REQUIREMENT
productDiscountType.equals
enum<string>
Available options:
EACH_PRODUCT,
SELECTED_PRODUCT
productDiscountType.notEquals
enum<string>
Available options:
EACH_PRODUCT,
SELECTED_PRODUCT
productDiscountType.specified
boolean
productDiscountType.in
enum<string>[]
Available options:
EACH_PRODUCT,
SELECTED_PRODUCT
productDiscountType.notIn
enum<string>[]
Available options:
EACH_PRODUCT,
SELECTED_PRODUCT
countrySelectionType.equals
enum<string>
Available options:
ALL_COUNTRY,
SELECTED_COUNTRY
countrySelectionType.notEquals
enum<string>
Available options:
ALL_COUNTRY,
SELECTED_COUNTRY
countrySelectionType.specified
boolean
countrySelectionType.in
enum<string>[]
Available options:
ALL_COUNTRY,
SELECTED_COUNTRY
countrySelectionType.notIn
enum<string>[]
Available options:
ALL_COUNTRY,
SELECTED_COUNTRY
discountApplyApproach.equals
enum<string>
Available options:
SHOPIFY_DISCOUNT_FUNCTION,
SHOPIFY_DISCOUNT_API
discountApplyApproach.notEquals
enum<string>
Available options:
SHOPIFY_DISCOUNT_FUNCTION,
SHOPIFY_DISCOUNT_API
discountApplyApproach.specified
boolean
discountApplyApproach.in
enum<string>[]
Available options:
SHOPIFY_DISCOUNT_FUNCTION,
SHOPIFY_DISCOUNT_API
discountApplyApproach.notIn
enum<string>[]
Available options:
SHOPIFY_DISCOUNT_FUNCTION,
SHOPIFY_DISCOUNT_API
discountedProductChooseType.equals
enum<string>
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
discountedProductChooseType.notEquals
enum<string>
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
discountedProductChooseType.specified
boolean
discountedProductChooseType.in
enum<string>[]
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
discountedProductChooseType.notIn
enum<string>[]
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
internalName.contains
string
internalName.doesNotContain
string
internalName.equals
string
internalName.notEquals
string
internalName.specified
boolean
internalName.in
string[]
internalName.notIn
string[]
limitToUsePerCustomer.greaterThan
integer<int32>
limitToUsePerCustomer.lessThan
integer<int32>
limitToUsePerCustomer.greaterThanOrEqual
integer<int32>
limitToUsePerCustomer.lessThanOrEqual
integer<int32>
limitToUsePerCustomer.equals
integer<int32>
limitToUsePerCustomer.notEquals
integer<int32>
limitToUsePerCustomer.specified
boolean
limitToUsePerCustomer.in
integer<int32>[]
limitToUsePerCustomer.notIn
integer<int32>[]
discountedVariantSelectionLimit.greaterThan
integer<int32>
discountedVariantSelectionLimit.lessThan
integer<int32>
discountedVariantSelectionLimit.greaterThanOrEqual
integer<int32>
discountedVariantSelectionLimit.lessThanOrEqual
integer<int32>
discountedVariantSelectionLimit.equals
integer<int32>
discountedVariantSelectionLimit.notEquals
integer<int32>
discountedVariantSelectionLimit.specified
boolean
discountedVariantSelectionLimit.in
integer<int32>[]
discountedVariantSelectionLimit.notIn
integer<int32>[]
hideOneTimePurchase.equals
boolean
hideOneTimePurchase.notEquals
boolean
hideOneTimePurchase.specified
boolean
hideOneTimePurchase.in
boolean[]
hideOneTimePurchase.notIn
boolean[]
hideSubscriptionPurchase.equals
boolean
hideSubscriptionPurchase.notEquals
boolean
hideSubscriptionPurchase.specified
boolean
hideSubscriptionPurchase.in
boolean[]
hideSubscriptionPurchase.notIn
boolean[]
maxOrderAmount.greaterThan
number<double>
maxOrderAmount.lessThan
number<double>
maxOrderAmount.greaterThanOrEqual
number<double>
maxOrderAmount.lessThanOrEqual
number<double>
maxOrderAmount.equals
number<double>
maxOrderAmount.notEquals
number<double>
maxOrderAmount.specified
boolean
maxOrderAmount.in
number<double>[]
maxOrderAmount.notIn
number<double>[]
productSelectionType.equals
enum<string>
Available options:
PRODUCT,
COLLECTION
productSelectionType.notEquals
enum<string>
Available options:
PRODUCT,
COLLECTION
productSelectionType.specified
boolean
productSelectionType.in
enum<string>[]
Available options:
PRODUCT,
COLLECTION
productSelectionType.notIn
enum<string>[]
Available options:
PRODUCT,
COLLECTION
tag.contains
string
tag.doesNotContain
string
tag.equals
string
tag.notEquals
string
tag.specified
boolean
tag.in
string[]
tag.notIn
string[]
productChooseType.equals
enum<string>
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
productChooseType.notEquals
enum<string>
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
productChooseType.specified
boolean
productChooseType.in
enum<string>[]
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
productChooseType.notIn
enum<string>[]
Available options:
CHOOSE_ALL,
CHOOSE_ONE,
CHOOSE_SPECIFIC
variantSelectionLimit.greaterThan
integer<int32>
variantSelectionLimit.lessThan
integer<int32>
variantSelectionLimit.greaterThanOrEqual
integer<int32>
variantSelectionLimit.lessThanOrEqual
integer<int32>
variantSelectionLimit.equals
integer<int32>
variantSelectionLimit.notEquals
integer<int32>
variantSelectionLimit.specified
boolean
variantSelectionLimit.in
integer<int32>[]
variantSelectionLimit.notIn
integer<int32>[]
discountTargetType.equals
enum<string>
Available options:
PRODUCT,
VARIANT,
ANY
discountTargetType.notEquals
enum<string>
Available options:
PRODUCT,
VARIANT,
ANY
discountTargetType.specified
boolean
discountTargetType.in
enum<string>[]
Available options:
PRODUCT,
VARIANT,
ANY
discountTargetType.notIn
enum<string>[]
Available options:
PRODUCT,
VARIANT,
ANY
enableSubscription.equals
boolean
enableSubscription.notEquals
boolean
enableSubscription.specified
boolean
enableSubscription.in
boolean[]
enableSubscription.notIn
boolean[]
subscriptionWidgetPosition.equals
enum<string>
Available options:
ABOVE,
BELOW
subscriptionWidgetPosition.notEquals
enum<string>
Available options:
ABOVE,
BELOW
subscriptionWidgetPosition.specified
boolean
subscriptionWidgetPosition.in
enum<string>[]
Available options:
ABOVE,
BELOW
subscriptionWidgetPosition.notIn
enum<string>[]
Available options:
ABOVE,
BELOW
subscribeTitle.contains
string
subscribeTitle.doesNotContain
string
subscribeTitle.equals
string
subscribeTitle.notEquals
string
subscribeTitle.specified
boolean
subscribeTitle.in
string[]
subscribeTitle.notIn
string[]
subscribeSubtitle.contains
string
subscribeSubtitle.doesNotContain
string
subscribeSubtitle.equals
string
subscribeSubtitle.notEquals
string
subscribeSubtitle.specified
boolean
subscribeSubtitle.in
string[]
subscribeSubtitle.notIn
string[]
subscriptionPreselected.equals
boolean
subscriptionPreselected.notEquals
boolean
subscriptionPreselected.specified
boolean
subscriptionPreselected.in
boolean[]
subscriptionPreselected.notIn
boolean[]
getYAppliesOn.equals
enum<string>
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
getYAppliesOn.notEquals
enum<string>
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
getYAppliesOn.specified
boolean
getYAppliesOn.in
enum<string>[]
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
getYAppliesOn.notIn
enum<string>[]
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
announcementBarMessage.contains
string
announcementBarMessage.doesNotContain
string
announcementBarMessage.equals
string
announcementBarMessage.notEquals
string
announcementBarMessage.specified
boolean
announcementBarMessage.in
string[]
announcementBarMessage.notIn
string[]
automaticDiscountNodeId.contains
string
automaticDiscountNodeId.doesNotContain
string
automaticDiscountNodeId.equals
string
automaticDiscountNodeId.notEquals
string
automaticDiscountNodeId.specified
boolean
automaticDiscountNodeId.in
string[]
automaticDiscountNodeId.notIn
string[]
recurringCycleLimit.greaterThan
integer<int32>
recurringCycleLimit.lessThan
integer<int32>
recurringCycleLimit.greaterThanOrEqual
integer<int32>
recurringCycleLimit.lessThanOrEqual
integer<int32>
recurringCycleLimit.equals
integer<int32>
recurringCycleLimit.notEquals
integer<int32>
recurringCycleLimit.specified
boolean
recurringCycleLimit.in
integer<int32>[]
recurringCycleLimit.notIn
integer<int32>[]
automaticShippingDiscountNodeId.contains
string
automaticShippingDiscountNodeId.doesNotContain
string
automaticShippingDiscountNodeId.equals
string
automaticShippingDiscountNodeId.notEquals
string
automaticShippingDiscountNodeId.specified
boolean
automaticShippingDiscountNodeId.in
string[]
automaticShippingDiscountNodeId.notIn
string[]
scheduledBundleRule.equals
boolean
scheduledBundleRule.notEquals
boolean
scheduledBundleRule.specified
boolean
scheduledBundleRule.in
boolean[]
scheduledBundleRule.notIn
boolean[]
bundleActiveFrom.greaterThan
string<date-time>
bundleActiveFrom.lessThan
string<date-time>
bundleActiveFrom.greaterThanOrEqual
string<date-time>
bundleActiveFrom.lessThanOrEqual
string<date-time>
bundleActiveFrom.equals
string<date-time>
bundleActiveFrom.notEquals
string<date-time>
bundleActiveFrom.specified
boolean
bundleActiveFrom.in
string<date-time>[]
bundleActiveFrom.notIn
string<date-time>[]
bundleActiveTo.greaterThan
string<date-time>
bundleActiveTo.lessThan
string<date-time>
bundleActiveTo.greaterThanOrEqual
string<date-time>
bundleActiveTo.lessThanOrEqual
string<date-time>
bundleActiveTo.equals
string<date-time>
bundleActiveTo.notEquals
string<date-time>
bundleActiveTo.specified
boolean
bundleActiveTo.in
string<date-time>[]
bundleActiveTo.notIn
string<date-time>[]
bundleSubType.equals
enum<string>
Available options:
BUY_X_GET_Y,
FIXED_BUNDLE
bundleSubType.notEquals
enum<string>
Available options:
BUY_X_GET_Y,
FIXED_BUNDLE
bundleSubType.specified
boolean
bundleSubType.in
enum<string>[]
Available options:
BUY_X_GET_Y,
FIXED_BUNDLE
bundleSubType.notIn
enum<string>[]
Available options:
BUY_X_GET_Y,
FIXED_BUNDLE
discountAppliesOn.equals
enum<string>
Available options:
PER_QUANTITY,
PER_ORDER,
PER_LINE_ITEM
discountAppliesOn.notEquals
enum<string>
Available options:
PER_QUANTITY,
PER_ORDER,
PER_LINE_ITEM
discountAppliesOn.specified
boolean
discountAppliesOn.in
enum<string>[]
Available options:
PER_QUANTITY,
PER_ORDER,
PER_LINE_ITEM
discountAppliesOn.notIn
enum<string>[]
Available options:
PER_QUANTITY,
PER_ORDER,
PER_LINE_ITEM
layoutType.equals
enum<string>
Available options:
LAYOUT_ONE,
LAYOUT_TWO,
LAYOUT_THREE,
LAYOUT_FOUR
layoutType.notEquals
enum<string>
Available options:
LAYOUT_ONE,
LAYOUT_TWO,
LAYOUT_THREE,
LAYOUT_FOUR
layoutType.specified
boolean
layoutType.in
enum<string>[]
Available options:
LAYOUT_ONE,
LAYOUT_TWO,
LAYOUT_THREE,
LAYOUT_FOUR
layoutType.notIn
enum<string>[]
Available options:
LAYOUT_ONE,
LAYOUT_TWO,
LAYOUT_THREE,
LAYOUT_FOUR
enableVolumeDiscountUpsell.equals
boolean
enableVolumeDiscountUpsell.notEquals
boolean
enableVolumeDiscountUpsell.specified
boolean
enableVolumeDiscountUpsell.in
boolean[]
enableVolumeDiscountUpsell.notIn
boolean[]
enableProgressiveGifts.equals
boolean
enableProgressiveGifts.notEquals
boolean
enableProgressiveGifts.specified
boolean
enableProgressiveGifts.in
boolean[]
enableProgressiveGifts.notIn
boolean[]
discountName.contains
string
discountName.doesNotContain
string
discountName.equals
string
discountName.notEquals
string
discountName.specified
boolean
discountName.in
string[]
discountName.notIn
string[]
shippingDiscountType.equals
enum<string>
Available options:
NO_DISCOUNT,
FREE_SHIPPING_FOR_BUNDLE_ONLY,
FREE_SHIPPING_FOR_ENTIRE_ORDER
shippingDiscountType.notEquals
enum<string>
Available options:
NO_DISCOUNT,
FREE_SHIPPING_FOR_BUNDLE_ONLY,
FREE_SHIPPING_FOR_ENTIRE_ORDER
shippingDiscountType.specified
boolean
shippingDiscountType.in
enum<string>[]
Available options:
NO_DISCOUNT,
FREE_SHIPPING_FOR_BUNDLE_ONLY,
FREE_SHIPPING_FOR_ENTIRE_ORDER
shippingDiscountType.notIn
enum<string>[]
Available options:
NO_DISCOUNT,
FREE_SHIPPING_FOR_BUNDLE_ONLY,
FREE_SHIPPING_FOR_ENTIRE_ORDER
inventoryTrackingMode.equals
enum<string>
Available options:
ADD_CHILD_PRODUCT_ON_ORDER,
ADD_CHILD_PRODUCT_ON_CHECKOUT
inventoryTrackingMode.notEquals
enum<string>
Available options:
ADD_CHILD_PRODUCT_ON_ORDER,
ADD_CHILD_PRODUCT_ON_CHECKOUT
inventoryTrackingMode.specified
boolean
inventoryTrackingMode.in
enum<string>[]
Available options:
ADD_CHILD_PRODUCT_ON_ORDER,
ADD_CHILD_PRODUCT_ON_CHECKOUT
inventoryTrackingMode.notIn
enum<string>[]
Available options:
ADD_CHILD_PRODUCT_ON_ORDER,
ADD_CHILD_PRODUCT_ON_CHECKOUT
distinct
boolean
page
integer
default:0

Zero-based page index (0..N)

Required range: x >= 0
size
integer
default:20

The size of the page to be returned

Required range: x >= 1
sort
string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

200 - */*

OK

allowMixAndMatchBelowMinimumTier
boolean
allowedCountries
string
allowedTags
string
announcementBarMessage
string
appliesOn
enum<string>
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
autofillNotChosenItems
boolean
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>
breadCrumbSelectSectionIconUrl
string
bundleActiveFrom
string<date-time>
bundleActiveTo
string<date-time>
bundleCheckoutSectionPosition
enum<string>
Available options:
ABOVE,
BELOW
bundleHtml
string
bundlePageBackgroundColor
string
bundleProductId
integer<int64>
bundleProductNameSortOrder
enum<string>
Available options:
DEFAULT,
ASC,
DESC
bundleRedirect
enum<string>
Available options:
CART,
CHECKOUT,
CUSTOM,
NONE
bundleSubType
enum<string>
Available options:
BUY_X_GET_Y,
FIXED_BUNDLE
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
buttonPriceSelector
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
comboProductFullPriceFontSize
integer<int32>
comboProductFullPriceFontStyle
string
comboProductPriceFontSize
integer<int32>
comboProductPriceFontStyle
string
comboProductTitleFontSize
integer<int32>
comboProductTitleFontStyle
string
combos
string
compareAtPriceSelector
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
defaultVariants
string
description
string
disableCartLineForSelectedBundleItems
boolean
disableHighestTierPreference
boolean
disableProductDescription
boolean
disableQuantityRestrictedSection
boolean
disableScrollingToBundle
boolean
disableTierRestriction
boolean
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
discountBadgeSelector
string
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
enableCompactMixAndMatchVariants
boolean
enableDedicatedAddToCartButton
boolean
enableMixAndMatchNativeAddToCart
boolean
enableOrderDiscountClass
boolean
enableProgressiveGifts
boolean
enableSequentialProductLoading
boolean
enableSubscription
boolean
enableTriggerFreeGiftWithoutWidget
boolean
enableVolumeDiscountMixAndMatch
boolean
enableVolumeDiscountTierRestriction
boolean
enableVolumeDiscountUpsell
boolean
excludeSubscriptionPlans
string
externalBuildABoxId
integer<int64>
fieldDisabledBackgroundColor
string
fixedBundleProductPageAddToBundleButtonBackgroundColor
string
fixedBundleProductPageAddToBundleButtonTextColor
string
fixedBundleProductPageAddToBundleLabel
string
fixedBundleProductPageAddToCartLabel
string
fixedBundleProductPageAddingToCartLabel
string
fixedBundleProductPageAdditionalOrderNoteLabel
string
fixedBundleProductPageAllSetLabel
string
fixedBundleProductPageAllSetLabelColor
string
fixedBundleProductPageBorderRadius
integer<int32>
fixedBundleProductPageBreakdownFreeBadgeBackgroundColor
string
fixedBundleProductPageBreakdownFreeBadgeTextColor
string
fixedBundleProductPageBreakdownLabel
string
fixedBundleProductPageBreakdownToggleFontSize
integer<int32>
fixedBundleProductPageBreakdownToggleFontStyle
string
fixedBundleProductPageBreakdownYouPayColor
string
fixedBundleProductPageCardBackgroundColor
string
fixedBundleProductPageCardBorderColor
string
fixedBundleProductPageCardPadding
integer<int32>
fixedBundleProductPageCheckoutButtonBackgroundColor
string
fixedBundleProductPageCheckoutButtonFontSize
integer<int32>
fixedBundleProductPageCheckoutButtonFontStyle
string
fixedBundleProductPageCheckoutButtonTextColor
string
fixedBundleProductPageChildCompareAtPriceColor
string
fixedBundleProductPageChildFixedQtyBackgroundColor
string
fixedBundleProductPageChildPriceFontSize
integer<int32>
fixedBundleProductPageChildPriceFontStyle
string
fixedBundleProductPageChildTitleColor
string
fixedBundleProductPageChildTitleFontSize
integer<int32>
fixedBundleProductPageChildTitleFontStyle
string
fixedBundleProductPageChildVariantColor
string
fixedBundleProductPageChooseAssociatedProductsLabel
string
fixedBundleProductPageChooseSourceProductLabel
string
fixedBundleProductPageContentsSubtitleColor
string
fixedBundleProductPageContentsTitleColor
string
fixedBundleProductPageContentsTitleFontSize
integer<int32>
fixedBundleProductPageContentsTitleFontStyle
string
fixedBundleProductPageCurrentlyOutOfStockTooltip
string
fixedBundleProductPageDetailsMediaBackgroundColor
string
fixedBundleProductPageEmptyContentsLabel
string
fixedBundleProductPageFixedContentsTitle
string
fixedBundleProductPageFlexibleContentsTitle
string
fixedBundleProductPageFreeLabel
string
fixedBundleProductPageItemsInsideLabel
string
fixedBundleProductPageLowStockLabel
string
fixedBundleProductPageLowStockTooltip
string
fixedBundleProductPageMaximumQuantityLabel
string
fixedBundleProductPageMinimumQuantityLabel
string
fixedBundleProductPageNotEligibleLabel
string
fixedBundleProductPageOrderNoteLabel
string
fixedBundleProductPageOutOfStockCheckoutMessage
string
fixedBundleProductPageOutOfStockLabel
string
fixedBundleProductPageOutOfStockTooltip
string
fixedBundleProductPageParentCompareAtPriceColor
string
fixedBundleProductPageParentEyebrowColor
string
fixedBundleProductPageParentPriceColor
string
fixedBundleProductPageParentPriceFontSize
integer<int32>
fixedBundleProductPageParentPriceFontStyle
string
fixedBundleProductPageParentTitleColor
string
fixedBundleProductPageParentTitleFontSize
integer<int32>
fixedBundleProductPageParentTitleFontStyle
string
fixedBundleProductPagePickAnyLabel
string
fixedBundleProductPagePickMaxLabel
string
fixedBundleProductPagePickMinLabel
string
fixedBundleProductPagePickRangeLabel
string
fixedBundleProductPagePriceBreakdownTitle
string
fixedBundleProductPageProgressBarFillColor
string
fixedBundleProductPageProgressBarTrackColor
string
fixedBundleProductPageProgressLabel
string
fixedBundleProductPagePurchaseOptionBorderColor
string
fixedBundleProductPagePurchaseOptionLabel
string
fixedBundleProductPagePurchaseOptionLabelColor
string
fixedBundleProductPagePurchaseOptionSelectedColor
string
fixedBundleProductPageRequiredLoginLabel
string
fixedBundleProductPageSelectOptionLabel
string
fixedBundleProductPageSubscriptionSaveLabel
string
fixedBundleProductPageTotalValueLabel
string
fixedBundleProductPageValidationMessageColor
string
fixedBundleProductPageYouPayLabel
string
fixedBundleProductPageYourBundleLabel
string
freeShipping
boolean
getYAppliesOn
enum<string>
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
hasOptionChanges
boolean
hasProductChanges
boolean
headingTextColor
string
hideOneTimePurchase
boolean
hideOutOfStockVariants
boolean
hideQuantitySelector
boolean
hideSubscriptionPurchase
boolean
id
integer<int64>
includedSubscriptionPlans
string
initialVisibleMixAndMatchVariantCount
integer<int32>
insufficientStockLabel
string
internalName
string
inventoryTrackingMode
enum<string>
Available options:
ADD_CHILD_PRODUCT_ON_ORDER,
ADD_CHILD_PRODUCT_ON_CHECKOUT
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>
mixAndMatchAddButtonLabel
string
mixAndMatchAddToCartLabel
string
mixAndMatchAddedItemsLabel
string
mixAndMatchGiftBadgeLabel
string
mixAndMatchLockedLabel
string
mixAndMatchNoProductSelectedLabel
string
mixAndMatchNoProductsAvailableLabel
string
mixAndMatchSeeAllLabel
string
mixAndMatchTierDiscountLabel
string
mixAndMatchTierQuantityLabel
string
mixAndMatchUnlockedLabel
string
mixAndMatchUpsellBadgeLabel
string
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>
priceSelector
string
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:
EACH_PRODUCT,
SELECTED_PRODUCT
productFilterConfig
string
productHandle
string
productSelectionType
enum<string>
Available options:
PRODUCT,
COLLECTION
productViewStyle
enum<string>
Available options:
QUICK_ADD,
VIEW_DETAILS
products
string
progressiveGift
string
purchaseRequirement
enum<string>
Available options:
MINIMUM_AMOUNT,
MINIMUM_QUANTITY,
NO_REQUIREMENT
recurringCycleLimit
integer<int32>
removeBundlePropertiesWhenNoDiscount
boolean
restrictTags
string
ruleUpsellSubTitleFontSize
integer<int32>
ruleUpsellSubTitleTextColor
string
ruleUpsellTitleFontSize
integer<int32>
ruleUpsellTitleTextColor
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
sellingPlanDisplayType
enum<string>
Available options:
DROPDOWN,
RADIO
sellingPlanSource
enum<string>
Available options:
PRODUCT,
SUBSCRIPTION_WIDGET
sellingPlanType
enum<string>
Available options:
BUNDLE_LEVEL,
PRODUCT_LEVEL
sequenceNo
integer<int32>
sequentialProductsPerBatch
integer<int32>
settings
string
shippingDiscountType
enum<string>
Available options:
NO_DISCOUNT,
FREE_SHIPPING_FOR_BUNDLE_ONLY,
FREE_SHIPPING_FOR_ENTIRE_ORDER
shop
string
showAdditionalNoteInput
boolean
showBundleInProductPage
boolean
showClassicBundleWidgetInChildProduct
boolean
showComboBundleWidgetInComboProduct
boolean
showCompareAtPrice
boolean
showPriceOfChosenProductsOnly
boolean
showPriceWithSubscriptionPrice
boolean
showPricesWithoutDecimal
boolean
showSectionedBundleDiscountProgressBar
boolean
showSellingPlanDescription
boolean
showUnitPrice
boolean
singleProductSettings
string
status
enum<string>
Available options:
ACTIVE,
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
themeProductPriceType
enum<string>
Available options:
PRICE_PER_ITEM,
BUNDLE_PRICE
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
tierUpsellBackgroundColor
string
tierUpsellSubTitleFontSize
integer<int32>
tierUpsellSubTitleTextColor
string
tierUpsellTitleFontSize
integer<int32>
tierUpsellTitleTextColor
string
tieredDiscount
string
topBarDiscountRequiredAmountMessage
string
topBarDiscountRequiredQuantityMessage
string
topBarDiscountUnlockTitlePrefix
string
topBarFixedDiscountMessage
string
topBarFreeShippingMessage
string
topBarPercentDiscountMessage
string
totalOrderValue
number<double>
totalVisitor
integer<int64>
trackInventory
boolean
translations
string
uniqueRef
string
unitLabel
string
updateThemeProductPrice
boolean
upsellProductSelectionMode
string
upsellSubTitle
string
upsellTitle
string
upsells
string
useOriginalPriceForBuyXTotal
boolean
validateInventoryQuantity
boolean
variantSelectionLimit
integer<int32>
variantVisibilityType
enum<string>
Available options:
SHOW_VARIANTS_AS_INDIVIDUAL,
SHOW_VARIANTS_AS_OPTIONS
variants
string
volumeAmountDiscountQuantityRewardsLabel
string
volumeAmountDiscountSaveRewardsLabel
string
volumeAmountDiscountSpentAmountRewardsLabel
string
volumeDiscountQuantityRewardsLabel
string
volumeDiscountSaveRewardsLabel
string
volumeDiscountSpentAmountRewardsLabel
string