v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Read bundle details

get/2023-10/bundle/{id}

Path parameters

versionstring required

YYYY-MM

idstring required

Bundle ID

Response

200

successboolean

messagestring

codestring

{"stackTrail":"paths:/2023-10/bundle/{id}:get:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Bundle info fetched successfully",
  "data": {
    "id": "49317797aa47477198b3cf7976f484aa",
    "name": "Hyper fresh golden yolk free range eggs (Thursday delivery)",
    "description": "We deliver to your postcode area on Thursdays. Order cut-offThe cut-off for Thursday deliver is [cut-off day & time]. Orders placed after this time will be delivered the following Thursday.",
    "imageURL": "https://cdn.shopify.com/s/files/1/0679/4779/0645/files/12eggs_a10d69db-f473-47c4-a625-48050a1d8613.webp?v=1698303687",
    "status": "ACTIVE",
    "type": "FIXED",
    "purchaseType": "SUBSCRIPTION",
    "currencyCode": "USD",
    "currencySymbol": "$",
    "boxSizes": [
      {
        "id": "01HHD6D5XDTFFA83RSZ8XNEKT9",
        "name": "BOX12",
        "minSize": 12
      }
    ],
    "discounts": [
      {
        "id": "01HHC6AHR8VQM2H6R59YZM7C8R",
        "name": "LPBNDL_DISCOUNT_4",
        "code": "LPBNDLh9lab",
        "type": "FIXED",
        "value": 4,
        "minCartQuantity": 12,
        "conditionType": "QUANTITY",
        "purchaseType": "SUBSCRIPTION"
      }
    ],
    "sellingPlans": [
      {
        "shopifyId": 1051852993,
        "name": "Deliver every month",
        "discounts": [
          {
            "type": "PERCENTAGE",
            "value": 11
          }
        ],
        "deliveryInterval": "MONTH",
        "deliveryIntervalCount": 1,
        "billingInterval": "MONTH",
        "billingIntervalCount": 1
      }
    ],
    "products": [
      {
        "shopifyId": 9332875985111,
        "title": "Dawn",
        "handle": "dawn",
        "status": "active",
        "options": [
          {
            "id": 11635076137263,
            "name": "Title",
            "values": [
              "Default Title"
            ],
            "position": 1,
            "product_id": 9332875985199
          }
        ],
        "variants": [
          {
            "shopifyId": 47875709174063,
            "title": "Default Title",
            "price": "10.99",
            "position": 1,
            "taxable": true,
            "imageURL": "https://cdn.shopify.com/s/files/1/0825/7581/9055/products/Untitleddesign_7_720x720_082773be-48c7-4314-8ade-be8a7c02f7f9.png?v=1698310759"
          }
        ],
        "limits": [
          {
            "boxSizeId": "01HHC6A5XMTGGA83RSZ8BNEKT9"
          }
        ]
      }
    ]
  },
  "code": "SUCCESS"
}