Build-a-Box & Bundles
Get bundle details by handle
Retrieves complete details for a subscription bundle using its unique handle. This endpoint returns the bundle configuration, included products, pricing, and available subscription options.
Bundle Information Returned:
- Bundle name and description
- Product selections with quantities
- Pricing and discounts
- Available subscription frequencies
- Bundle status and availability
- Product images and details
Use Cases:
- Display bundle details on product pages
- Show bundle contents in customer portal
- Fetch bundle configuration for cart/checkout
- Integration with external systems
- Build custom bundle selection interfaces
Bundle Handle: The handle is a unique, URL-friendly identifier for the bundle. It’s typically generated when the bundle is created and remains constant throughout the bundle’s lifecycle.
Authentication: Requires valid X-API-Key header
GET
/
api
/
external
/
v2
/
subscription-bundlings
/
external
/
get-bundle
/
{handle}
Get bundle details by handle
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/get-bundle/{handle}import requests
url = "https://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/get-bundle/{handle}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/get-bundle/{handle}', 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-bundlings/external/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://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/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://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/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://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/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": {
"currencyCode": "USD",
"description": "Choose your favorite coffee blends",
"handle": "premium-coffee-bundle",
"id": 12345,
"maxProducts": 5,
"minProducts": 2,
"name": "Premium Coffee Bundle",
"totalPrice": "49.99"
},
"products": [
{
"available": true,
"image": "https://cdn.shopify.com/image.jpg",
"price": "14.99",
"productId": 99999,
"title": "Medium Roast Coffee",
"variantId": 11111
}
],
"subscriptions": [
{
"discount": 10,
"discountType": "PERCENTAGE",
"frequency": "MONTH",
"frequencyCount": 1,
"frequencyName": "Monthly Delivery"
},
{
"discount": 15,
"discountType": "PERCENTAGE",
"frequency": "WEEK",
"frequencyCount": 2,
"frequencyName": "Bi-Weekly Delivery"
}
]
}{
"bundle": {
"shop": "<string>",
"allowOneTimePurchase": true,
"bundleBottomHtml": "<string>",
"bundleTopHtml": "<string>",
"chooseProductsText": "<string>",
"collectionData": "<string>",
"customRedirectURL": "<string>",
"discount": 123,
"discountedVariants": "<string>",
"id": 123,
"maxProductCount": 123,
"minOrderAmount": 123,
"minProductCount": 123,
"minUniqueProductCheck": true,
"name": "<string>",
"proceedToCheckoutButtonText": "<string>",
"sections": "<string>",
"sellingPlanIds": "<string>",
"singleProductSettings": "<string>",
"subscriptionBundlingEnabled": true,
"subscriptionGroup": "<string>",
"subscriptionId": 123,
"thirdPartyRule": true,
"tieredDiscount": "<string>",
"trackInventory": true,
"uniqueRef": "<string>",
"variants": "<string>"
},
"products": [
{
"shop": "<string>",
"id": 123,
"productHandle": "<string>",
"productId": 123,
"productTitle": "<string>"
}
],
"subscriptions": [
{
"shop": "<string>",
"groupName": "<string>",
"id": 123,
"infoJson": "<string>",
"productCount": 123,
"productIds": "<string>",
"productVariantCount": 123,
"subscriptionId": 123,
"translations": "<string>",
"variantIds": "<string>",
"variantProductIds": "<string>"
}
],
"variants": [
"<string>"
]
}{
"bundle": {
"shop": "<string>",
"allowOneTimePurchase": true,
"bundleBottomHtml": "<string>",
"bundleTopHtml": "<string>",
"chooseProductsText": "<string>",
"collectionData": "<string>",
"customRedirectURL": "<string>",
"discount": 123,
"discountedVariants": "<string>",
"id": 123,
"maxProductCount": 123,
"minOrderAmount": 123,
"minProductCount": 123,
"minUniqueProductCheck": true,
"name": "<string>",
"proceedToCheckoutButtonText": "<string>",
"sections": "<string>",
"sellingPlanIds": "<string>",
"singleProductSettings": "<string>",
"subscriptionBundlingEnabled": true,
"subscriptionGroup": "<string>",
"subscriptionId": 123,
"thirdPartyRule": true,
"tieredDiscount": "<string>",
"trackInventory": true,
"uniqueRef": "<string>",
"variants": "<string>"
},
"products": [
{
"shop": "<string>",
"id": 123,
"productHandle": "<string>",
"productId": 123,
"productTitle": "<string>"
}
],
"subscriptions": [
{
"shop": "<string>",
"groupName": "<string>",
"id": 123,
"infoJson": "<string>",
"productCount": 123,
"productIds": "<string>",
"productVariantCount": 123,
"subscriptionId": 123,
"translations": "<string>",
"variantIds": "<string>",
"variantProductIds": "<string>"
}
],
"variants": [
"<string>"
]
}{
"detail": "No bundle exists with handle: premium-coffee-bundle",
"status": 404,
"title": "Bundle not found",
"type": "https://example.com/errors/not-found"
}⌘I
Get bundle details by handle
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/get-bundle/{handle}import requests
url = "https://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/get-bundle/{handle}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/get-bundle/{handle}', 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-bundlings/external/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://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/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://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/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://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/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": {
"currencyCode": "USD",
"description": "Choose your favorite coffee blends",
"handle": "premium-coffee-bundle",
"id": 12345,
"maxProducts": 5,
"minProducts": 2,
"name": "Premium Coffee Bundle",
"totalPrice": "49.99"
},
"products": [
{
"available": true,
"image": "https://cdn.shopify.com/image.jpg",
"price": "14.99",
"productId": 99999,
"title": "Medium Roast Coffee",
"variantId": 11111
}
],
"subscriptions": [
{
"discount": 10,
"discountType": "PERCENTAGE",
"frequency": "MONTH",
"frequencyCount": 1,
"frequencyName": "Monthly Delivery"
},
{
"discount": 15,
"discountType": "PERCENTAGE",
"frequency": "WEEK",
"frequencyCount": 2,
"frequencyName": "Bi-Weekly Delivery"
}
]
}{
"bundle": {
"shop": "<string>",
"allowOneTimePurchase": true,
"bundleBottomHtml": "<string>",
"bundleTopHtml": "<string>",
"chooseProductsText": "<string>",
"collectionData": "<string>",
"customRedirectURL": "<string>",
"discount": 123,
"discountedVariants": "<string>",
"id": 123,
"maxProductCount": 123,
"minOrderAmount": 123,
"minProductCount": 123,
"minUniqueProductCheck": true,
"name": "<string>",
"proceedToCheckoutButtonText": "<string>",
"sections": "<string>",
"sellingPlanIds": "<string>",
"singleProductSettings": "<string>",
"subscriptionBundlingEnabled": true,
"subscriptionGroup": "<string>",
"subscriptionId": 123,
"thirdPartyRule": true,
"tieredDiscount": "<string>",
"trackInventory": true,
"uniqueRef": "<string>",
"variants": "<string>"
},
"products": [
{
"shop": "<string>",
"id": 123,
"productHandle": "<string>",
"productId": 123,
"productTitle": "<string>"
}
],
"subscriptions": [
{
"shop": "<string>",
"groupName": "<string>",
"id": 123,
"infoJson": "<string>",
"productCount": 123,
"productIds": "<string>",
"productVariantCount": 123,
"subscriptionId": 123,
"translations": "<string>",
"variantIds": "<string>",
"variantProductIds": "<string>"
}
],
"variants": [
"<string>"
]
}{
"bundle": {
"shop": "<string>",
"allowOneTimePurchase": true,
"bundleBottomHtml": "<string>",
"bundleTopHtml": "<string>",
"chooseProductsText": "<string>",
"collectionData": "<string>",
"customRedirectURL": "<string>",
"discount": 123,
"discountedVariants": "<string>",
"id": 123,
"maxProductCount": 123,
"minOrderAmount": 123,
"minProductCount": 123,
"minUniqueProductCheck": true,
"name": "<string>",
"proceedToCheckoutButtonText": "<string>",
"sections": "<string>",
"sellingPlanIds": "<string>",
"singleProductSettings": "<string>",
"subscriptionBundlingEnabled": true,
"subscriptionGroup": "<string>",
"subscriptionId": 123,
"thirdPartyRule": true,
"tieredDiscount": "<string>",
"trackInventory": true,
"uniqueRef": "<string>",
"variants": "<string>"
},
"products": [
{
"shop": "<string>",
"id": 123,
"productHandle": "<string>",
"productId": 123,
"productTitle": "<string>"
}
],
"subscriptions": [
{
"shop": "<string>",
"groupName": "<string>",
"id": 123,
"infoJson": "<string>",
"productCount": 123,
"productIds": "<string>",
"productVariantCount": 123,
"subscriptionId": 123,
"translations": "<string>",
"variantIds": "<string>",
"variantProductIds": "<string>"
}
],
"variants": [
"<string>"
]
}{
"detail": "No bundle exists with handle: premium-coffee-bundle",
"status": 404,
"title": "Bundle not found",
"type": "https://example.com/errors/not-found"
}