Get public Build-a-Box bundle details by handle (v3)

GET /subscriptions/cp/api/v3/subscription-bundlings/external/get-bundle/{handle}

Get public Build-a-Box bundle details by handle (v3)

cURL

curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/v3/subscription-bundlings/external/get-bundle/{handle}

200

{
  "bundle": {
    "shop": "<string>",
    "id": 123,
    "subscriptionBundlingEnabled": true,
    "subscriptionId": 123,
    "minProductCount": 123,
    "maxProductCount": 123,
    "discount": 123,
    "uniqueRef": "<string>",
    "customRedirectURL": "<string>",
    "minOrderAmount": 123,
    "tieredDiscount": "<string>",
    "singleProductSettings": "<string>",
    "subscriptionGroup": "<string>",
    "bundleTopHtml": "<string>",
    "bundleBottomHtml": "<string>",
    "proceedToCheckoutButtonText": "<string>",
    "chooseProductsText": "<string>",
    "name": "<string>",
    "trackInventory": true,
    "allowOneTimePurchase": true,
    "thirdPartyRule": true,
    "variants": "<string>",
    "discountedVariants": "<string>",
    "sections": "<string>",
    "collectionData": "<string>",
    "sellingPlanIds": "<string>",
    "minUniqueProductCheck": true
  },
  "subscriptionPlanProductInfoMap": {},
  "subscriptionPlanVariantMap": {},
  "subscriptionGroupPlans": [
    {
      "shop": "<string>",
      "id": 123,
      "groupName": "<string>",
      "subscriptionId": 123,
      "productCount": 123,
      "productVariantCount": 123,
      "infoJson": "<string>",
      "productIds": "<string>",
      "variantIds": "<string>",
      "variantProductIds": "<string>",
      "translations": "<string>"
    }
  ],
  "subscription": {
    "shop": "<string>",
    "id": 123,
    "groupName": "<string>",
    "subscriptionId": 123,
    "productCount": 123,
    "productVariantCount": 123,
    "infoJson": "<string>",
    "productIds": "<string>",
    "variantIds": "<string>",
    "variantProductIds": "<string>",
    "translations": "<string>"
  },
  "products": [
    {
      "shop": "<string>",
      "id": 123,
      "productId": 123,
      "productTitle": "<string>",
      "productHandle": "<string>"
    }
  ],
  "variants": [
    "<string>"
  ]
}

Path Parameters

handle · string · required

Customer Handle

Response

200 - */*

OK

bundle · object

Show child attributes

subscriptionPlanProductInfoMap · object

Show child attributes

subscriptionPlanVariantMap · object

Show child attributes

subscriptionGroupPlans · object[]

Show child attributes

subscription · object

Show child attributes

products · object[]

Show child attributes

variants · string[]