Fetches the complete configuration and details of a specific Build-A-Box subscription bundle using its unique identifier. This endpoint returns all bundle settings including products, pricing, rules, and delivery options.
What You’ll Receive:
Use Cases:
Response Details: The response includes comprehensive information about the bundle:
Authorization:
Integration Tips:
active field to determine if the bundle is available to customersavailableProducts array to ensure product inventory availabilityPerformance Considerations:
Authentication: Requires valid X-API-Key header or api_key parameter (deprecated)
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/build-a-box/{id}{
"id": 45678,
"shop": "example-shop.myshopify.com",
"bundleName": "Premium Coffee Selection",
"bundleHandle": "premium-coffee-selection",
"uniqueRef": "bab_abc123xyz",
"description": "Choose your favorite coffee blends for monthly delivery",
"buildABoxType": "SINGLE_PRODUCT",
"buildBoxVersion": "V2",
"minProductCount": 2,
"maxProductCount": 5,
"minOrderAmount": 25,
"pricingType": "PER_PRODUCT",
"discount": 10,
"discountType": "PERCENTAGE",
"allowOneTimePurchase": true,
"thirdPartyRule": false,
"trackInventory": true,
"active": true,
"productViewStyle": "GRID",
"proceedToCheckoutButtonText": "Complete Your Subscription",
"chooseProductsText": "Build Your Perfect Coffee Box",
"availableProducts": [
{
"productId": 111111,
"variantId": 222222,
"title": "Medium Roast Coffee - 12oz",
"price": "14.99",
"imageUrl": "https://cdn.shopify.com/coffee-medium.jpg",
"available": true
},
{
"productId": 111111,
"variantId": 333333,
"title": "Dark Roast Coffee - 12oz",
"price": "15.99",
"imageUrl": "https://cdn.shopify.com/coffee-dark.jpg",
"available": true
}
],
"frequencies": [
{
"interval": "MONTH",
"intervalCount": 1,
"displayName": "Monthly"
},
{
"interval": "WEEK",
"intervalCount": 2,
"displayName": "Bi-Weekly"
}
],
"createdAt": "2024-03-15T10:30:00Z",
"updatedAt": "2024-03-20T14:45:00Z"
}Documentation Index
Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
Use this file to discover all available pages before exploring further.
API Key (Deprecated - Use Header X-API-Key instead)
Build-A-Box bundle successfully retrieved
CART, CHECKOUT, CUSTOM, NONE QUICK_ADD, VIEW_DETAILS CLASSIC, SINGLE_PRODUCT, MIX_AND_MATCH, INFINITE, CUSTOMIZE_BUNDLE, CLASSIC_BUILD_A_BOX, SINGLE_PRODUCT_BUILD_A_BOX, VOLUME_DISCOUNT, DISCOUNTED_PRICING, SHIPPING_DISCOUNT, BUY_X_GET_Y, SECTIONED_BUNDLE FIXED, FLEXIBLE PRODUCT, COLLECTION, BOTH, ONE_TIME, SUBSCRIPTION SELECTED_PRODUCT, EACH_PRODUCT PRODUCT, COLLECTION curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/build-a-box/{id}{
"id": 45678,
"shop": "example-shop.myshopify.com",
"bundleName": "Premium Coffee Selection",
"bundleHandle": "premium-coffee-selection",
"uniqueRef": "bab_abc123xyz",
"description": "Choose your favorite coffee blends for monthly delivery",
"buildABoxType": "SINGLE_PRODUCT",
"buildBoxVersion": "V2",
"minProductCount": 2,
"maxProductCount": 5,
"minOrderAmount": 25,
"pricingType": "PER_PRODUCT",
"discount": 10,
"discountType": "PERCENTAGE",
"allowOneTimePurchase": true,
"thirdPartyRule": false,
"trackInventory": true,
"active": true,
"productViewStyle": "GRID",
"proceedToCheckoutButtonText": "Complete Your Subscription",
"chooseProductsText": "Build Your Perfect Coffee Box",
"availableProducts": [
{
"productId": 111111,
"variantId": 222222,
"title": "Medium Roast Coffee - 12oz",
"price": "14.99",
"imageUrl": "https://cdn.shopify.com/coffee-medium.jpg",
"available": true
},
{
"productId": 111111,
"variantId": 333333,
"title": "Dark Roast Coffee - 12oz",
"price": "15.99",
"imageUrl": "https://cdn.shopify.com/coffee-dark.jpg",
"available": true
}
],
"frequencies": [
{
"interval": "MONTH",
"intervalCount": 1,
"displayName": "Monthly"
},
{
"interval": "WEEK",
"intervalCount": 2,
"displayName": "Bi-Weekly"
}
],
"createdAt": "2024-03-15T10:30:00Z",
"updatedAt": "2024-03-20T14:45:00Z"
}