Creates a new subscription bundle (Build-A-Box) allowing customers to select and customize products for recurring deliveries. Build-A-Box enables a flexible subscription model where customers can create personalized product boxes.
What is Build-A-Box? Build-A-Box is a subscription feature that allows customers to curate their own product bundles by selecting from a predefined set of products. This creates a highly personalized subscription experience where customers have full control over what they receive in each delivery cycle.
Key Features:
Configuration Options:
Bundle Settings:
Pricing Configuration:
Delivery Options:
Rules and Restrictions:
Build-A-Box Types:
Use Cases:
Customer Workflow:
Important Notes:
Best Practices:
Authentication: Requires valid X-API-Key header or api_key parameter (deprecated)
curl --request POST \
--url https://subscription-admin.appstle.com/api/external/v2/build-a-box \
--header 'Content-Type: application/json' \
--data '
{
"shop": "<string>"
}
'{
"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,
"pricingType": "PER_PRODUCT",
"discount": 10,
"discountType": "PERCENTAGE",
"allowOneTimePurchase": true,
"active": true,
"availableProducts": [
{
"productId": 111111,
"variantId": 222222,
"title": "Medium Roast Coffee - 12oz",
"price": "14.99",
"imageUrl": "https://cdn.shopify.com/coffee-medium.jpg"
},
{
"productId": 111111,
"variantId": 333333,
"title": "Dark Roast Coffee - 12oz",
"price": "15.99",
"imageUrl": "https://cdn.shopify.com/coffee-dark.jpg"
}
],
"frequencies": [
{
"interval": "MONTH",
"intervalCount": 1,
"displayName": "Monthly"
},
{
"interval": "WEEK",
"intervalCount": 2,
"displayName": "Bi-Weekly"
}
],
"createdAt": "2024-03-15T10:30:00Z",
"updatedAt": "2024-03-15T10:30: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)
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 Build-A-Box subscription bundle successfully created
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 POST \
--url https://subscription-admin.appstle.com/api/external/v2/build-a-box \
--header 'Content-Type: application/json' \
--data '
{
"shop": "<string>"
}
'{
"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,
"pricingType": "PER_PRODUCT",
"discount": 10,
"discountType": "PERCENTAGE",
"allowOneTimePurchase": true,
"active": true,
"availableProducts": [
{
"productId": 111111,
"variantId": 222222,
"title": "Medium Roast Coffee - 12oz",
"price": "14.99",
"imageUrl": "https://cdn.shopify.com/coffee-medium.jpg"
},
{
"productId": 111111,
"variantId": 333333,
"title": "Dark Roast Coffee - 12oz",
"price": "15.99",
"imageUrl": "https://cdn.shopify.com/coffee-dark.jpg"
}
],
"frequencies": [
{
"interval": "MONTH",
"intervalCount": 1,
"displayName": "Monthly"
},
{
"interval": "WEEK",
"intervalCount": 2,
"displayName": "Bi-Weekly"
}
],
"createdAt": "2024-03-15T10:30:00Z",
"updatedAt": "2024-03-15T10:30:00Z"
}