Skip to main content
GET
/
bundles
/
bb
/
api
/
build-a-box
/
get-bundle
/
{handle}
Get build-a-box configuration by handle
curl --request GET \
  --url https://bundles-admin.appstle.com/bundles/bb/api/build-a-box/get-bundle/{handle}
import requests

url = "https://bundles-admin.appstle.com/bundles/bb/api/build-a-box/get-bundle/{handle}"

response = requests.get(url)

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

fetch('https://bundles-admin.appstle.com/bundles/bb/api/build-a-box/get-bundle/{handle}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://bundles-admin.appstle.com/bundles/bb/api/build-a-box/get-bundle/{handle}';
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/bundles/bb/api/build-a-box/get-bundle/{handle}",
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/bundles/bb/api/build-a-box/get-bundle/{handle}"

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/bundles/bb/api/build-a-box/get-bundle/{handle}")

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
{
  "bundle": {
    "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>"
  },
  "products": [
    {
      "imageSrc": "<string>",
      "isMandatory": true,
      "maxQuantity": 123,
      "minQuantity": 123,
      "name": "<string>",
      "price": 123,
      "productHandle": "<string>",
      "productId": 123,
      "quantity": 123,
      "status": "<string>",
      "variantId": 123,
      "variantsCount": 123
    }
  ],
  "variants": [
    123
  ]
}

Path Parameters

handle
string
required

Response

200 - */*

OK

bundle
object
products
object[]
variants
integer<int64>[]