Skip to main content
GET
/
api
/
external
/
v2
/
subscription-bundle-settings
/
{id}
Get subscription bundle settings (Build-a-Box configuration)
curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}
import requests

url = "https://subscription-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}"

response = requests.get(url)

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

fetch('https://subscription-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://subscription-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}';
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://subscription-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}",
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://subscription-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}"

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://subscription-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}")

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
{
  "allowModifications": true,
  "categoryLimits": {
    "coffee-dark-roast": {
      "max": 3,
      "min": 0
    },
    "coffee-decaf": {
      "max": 2,
      "min": 0
    },
    "coffee-flavored": {
      "max": 2,
      "min": 0
    },
    "coffee-light-roast": {
      "max": 3,
      "min": 0
    },
    "coffee-medium-roast": {
      "max": 3,
      "min": 0
    }
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "discounts": {
    "enableVolumeDiscounts": true,
    "volumeDiscountTiers": [
      {
        "discountPercent": 10,
        "minProducts": 5
      },
      {
        "discountPercent": 15,
        "minProducts": 7
      }
    ]
  },
  "displaySettings": {
    "enableFiltering": true,
    "enableSearch": true,
    "layoutType": "GRID",
    "productsPerRow": 3,
    "showBundlePreview": true,
    "showPricing": false,
    "showProductDescriptions": true,
    "showProductImages": true
  },
  "enableProductRotation": true,
  "enabled": true,
  "fixedBundlePrice": 59.99,
  "id": 12345,
  "lockAfterFirstOrder": false,
  "maxBundleValue": 100,
  "maxProducts": 8,
  "maxSwapsPerCycle": 2,
  "minBundleValue": 40,
  "minProducts": 3,
  "modificationCutoffDays": 5,
  "notifications": {
    "reminderDaysBeforeOrder": 7,
    "sendBundleCreatedEmail": true,
    "sendBundleModifiedConfirmation": true,
    "sendModificationReminderEmail": true
  },
  "pricingModel": "FIXED_PRICE",
  "recommendations": {
    "enableRecommendations": true,
    "recommendationStrategy": "POPULAR_AND_PERSONALIZED",
    "showBestSellers": true,
    "showCuratedBundles": true
  },
  "requireCategoryDiversity": true,
  "shop": "example-shop.myshopify.com",
  "substitution": {
    "allowCustomerToApproveSubstitutions": false,
    "allowSubstitutions": true,
    "notifyCustomerOfSubstitutions": true,
    "substitutionMethod": "SIMILAR_PRODUCT"
  },
  "updatedAt": "2024-02-20T14:45:00Z"
}
{
"detail": "Valid X-API-Key header is required",
"status": 401,
"title": "Authentication required",
"type": "https://example.com/errors/unauthorized"
}
{
"detail": "API key does not have permission to view bundle settings",
"status": 403,
"title": "Insufficient permissions",
"type": "https://example.com/errors/forbidden"
}
{
"detail": "Subscription bundle settings have not been configured for this shop",
"status": 404,
"title": "Settings not found",
"type": "https://example.com/errors/not-found"
}

Headers

X-API-Key
string

Path Parameters

id
integer<int64>
required

Query Parameters

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

Response

Bundle settings successfully retrieved

addButtonText
string
required
myDeliveryText
string
required
proceedToCheckoutButtonText
string
required
productsToProceedText
string
required
selectMinimumProductButtonText
string
required
selectedFrequencyLabelText
string
required
shop
string
required
allowAddUnavailableProduct
boolean
backgroundColor
string
bundleBottomHtml
string
bundleRedirect
enum<string>
Available options:
CART,
CHECKOUT,
CUSTOM
bundleTopHtml
string
buttonBackgroundColor
string
buttonColor
string
buyQuantityGetDiscount
string
cart
string
checkoutMessage
string
congratsMessageText
string
continueShopping
string
currencySwitcherClassName
string
customRedirectURL
string
descriptionLength
integer<int32>
disableInventoryCheck
boolean
disableProductCardImageSlider
boolean
disableProductDescription
boolean
displayUnavailableProduct
boolean
editQuantity
string
enableClearCartSelectedProducts
boolean
enableCustomAdvancedFields
boolean
enableDisplayProductType
boolean
enableDisplayProductVendor
boolean
enableEditQuantityTextbox
boolean
enableOpeningSidebar
boolean
enableProductDetailButton
boolean
enableRedirectToProductPage
boolean
enableShowProductBasePrice
boolean
enableSkieyBABHeader
boolean
failedToAddMsgText
string
failedToAddTitleText
string
id
integer<int64>
isBundleWithoutScroll
boolean
isMergeIntoSingleBABVariantDropdown
boolean
itemsText
string
leftSidebarHTML
string
moveOneTimePurchaseToTop
boolean
okBtnText
string
openingSidebarType
enum<string>
Available options:
DEFAULT,
MAX_QUANTITY,
STOP_AUTO_OPEN,
MIN_AMOUNT
pageBackgroundColor
string
productDetails
string
productFilterConfig
string
productPriceFormatField
string
productTitleFontColor
string
quantityLabel
string
removeItem
string
restrictPriceRateCalculation
boolean
rightSidebarHTML
string
shopCustomizationData
object[]
shoppingCart
string
showCompareAtPrice
boolean
showOrderNoteField
boolean
showSubLoyaltyTable
boolean
skipFilterVariantsByAllocationsId
boolean
skipFirstPage
boolean
spendAmountGetDiscount
string
spentText
string
subtotal
string
tieredDiscount
string
title
string
variantLabelTextV2
string
variantNotAvailable
string
viewProduct
string