Update subscription bundling configuration

Updates the configuration for one or more subscription bundles (Build-a-Box). This endpoint allows bulk updates to bundle product selections, quantities, and configurations.

Full behavior, validation rules, and side effects

Subscription Bundling/Build-a-Box: Subscription bundling allows customers to create custom product bundles that are delivered on a recurring basis. Customers can select multiple products to be included in each delivery, creating a personalized subscription box.

Update Capabilities:

• Modify product selections within a bundle
• Update product quantities
• Change bundle configuration settings
• Bulk update multiple bundles at once

Use Cases:

• Customer updates their bundle product selections
• Swap products in an existing bundle
• Adjust quantities for products in the bundle
• Programmatically manage bundle configurations

Important Notes:

• Updates are identified by bundle handle (unique identifier)
• Only active bundles can be updated
• Product availability is validated before update

Authentication: Requires valid X-API-Key header

PUT /api/external/v2/subscription-bundling/update

Update subscription bundling configuration

cURL

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-bundling/update \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "babHandle": "<string>",
    "sourceProducts": [
      {
        "sourceProductId": 123,
        "addSubProductIds": [
          123
        ],
        "addSubVariantIds": [
          123
        ],
        "deleteSubProductIds": [
          123
        ],
        "deleteSubVariantIds": [
          123
        ]
      }
    ]
  }
]
'

200

{
  "id": 12345,
  "shop": "example-shop.myshopify.com",
  "token": "abc123xyz",
  "bundleName": "My Custom Coffee Bundle",
  "bundleHandle": "custom-coffee-bundle-123",
  "products": [
    {
      "variantId": 11111,
      "productTitle": "Medium Roast Coffee",
      "quantity": 2
    },
    {
      "variantId": 22222,
      "productTitle": "Dark Roast Coffee",
      "quantity": 1
    }
  ],
  "frequency": "MONTH",
  "frequencyCount": 1,
  "active": true
}

Headers

X-API-Key · string

Body

application/json

babHandle · string

sourceProducts · object[]

Show child attributes

Response

200

application/json

Subscription bundling successfully updated

shop · string · required

id · integer<int64>

subscriptionBundlingEnabled · boolean

subscriptionId · integer<int64>

minProductCount · integer<int32>

maxProductCount · integer<int32>

discount · number<double>

uniqueRef · string

groupName · string

subscriptionBundleLink · string

bundleRedirect · enum<string>

Available options: CART, CHECKOUT, CUSTOM, NONE

customRedirectURL · string

minOrderAmount · number<double>

tieredDiscount · string

productViewStyle · enum<string>

Available options: QUICK_ADD, VIEW_DETAILS

buildABoxType · enum<string>

Available options: 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

singleProductSettings · string

subscriptionGroup · string

bundleTopHtml · string

bundleBottomHtml · string

proceedToCheckoutButtonText · string

chooseProductsText · string

name · string

trackInventory · boolean

allowOneTimePurchase · boolean

thirdPartyRule · boolean

selectionType · enum<string>

Available options: FIXED, FLEXIBLE

variants · string

discountedVariants · string

sections · string

appliesOn · enum<string>

Available options: PRODUCT, COLLECTION, BOTH, ONE_TIME, SUBSCRIPTION

productDiscountType · enum<string>

Available options: SELECTED_PRODUCT, EACH_PRODUCT

collectionData · string

productSelectionType · enum<string>

Available options: PRODUCT, COLLECTION

sellingPlanIds · string

minUniqueProductCheck · boolean