External APIs (0.0.1)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

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:

• Product Selection: Customers choose which products to include in their box
• Quantity Control: Set minimum and maximum product quantities
• Flexible Configuration: Define rules for product combinations
• Pricing Models: Support for various pricing strategies (per-item, flat rate, tiered)
• Recurring Delivery: Automatic fulfillment based on subscription frequency
• Customization Options: Allow product swaps between delivery cycles

Configuration Options:

• Bundle Settings:

  • Bundle name and description
  • Unique handle for identification
  • Product pool (available products for selection)
  • Minimum/maximum number of products
  • Product quantity limits

• Pricing Configuration:

  • Pricing type (per-product, flat rate, or tiered)
  • Discount rules
  • Promotional pricing
  • Currency settings

• Delivery Options:

  • Subscription frequencies (weekly, bi-weekly, monthly, etc.)
  • Delivery intervals
  • Cut-off times for order modifications
  • Shipping methods

• Rules and Restrictions:

  • Product combination rules
  • Category restrictions
  • Inventory requirements
  • Customer eligibility criteria

Build-A-Box Types:

1. Open Selection: Customers can choose any products from the available pool
2. Category-Based: Products are organized into categories with selection rules
3. Single Product: Customers select variations of a single product type
4. Tiered Boxes: Different box sizes with varying product counts and pricing

Use Cases:

• Coffee Subscription: Customers select different coffee blends for monthly delivery
• Snack Boxes: Build custom snack boxes from a variety of treats
• Beauty Boxes: Choose skincare and makeup products based on preferences
• Meal Kits: Select recipes and ingredients for weekly meal planning
• Pet Supply Boxes: Customize toys, treats, and supplies for pets
• Supplement Subscriptions: Create personalized vitamin and supplement regimens

Customer Workflow:

1. Customer discovers Build-A-Box offering
2. Selects products from available options
3. Chooses delivery frequency
4. Reviews pricing and discounts
5. Completes subscription signup
6. Receives recurring deliveries
7. Can modify selections between delivery cycles

Important Notes:

• Each bundle must have a unique handle for identification
• Product availability is validated at creation time
• Pricing rules are applied based on bundle configuration
• Bundles must be associated with at least one subscription frequency
• Inventory levels should be checked for all included products
• Bundle status (active/inactive) controls customer visibility

Best Practices:

• Set clear minimum and maximum product limits
• Provide detailed product descriptions and images
• Configure appropriate pricing that encourages subscriptions
• Offer multiple delivery frequency options
• Set reasonable inventory thresholds
• Enable customer portal access for subscription management
• Test bundle configurations before making them live

Authentication: Requires valid X-API-Key header or api_key parameter (deprecated)

Retrieves complete details for a subscription bundle using its unique handle. This endpoint returns the bundle configuration, included products, pricing, and available subscription options.

Bundle Information Returned:

• Bundle name and description
• Product selections with quantities
• Pricing and discounts
• Available subscription frequencies
• Bundle status and availability
• Product images and details

Use Cases:

• Display bundle details on product pages
• Show bundle contents in customer portal
• Fetch bundle configuration for cart/checkout
• Integration with external systems
• Build custom bundle selection interfaces

Bundle Handle: The handle is a unique, URL-friendly identifier for the bundle. It's typically generated when the bundle is created and remains constant throughout the bundle's lifecycle.

Authentication: Requires valid X-API-Key header

Retrieves the configuration settings for subscription bundles (also known as Build-a-Box or customizable subscription boxes). This endpoint returns all settings that control how customers can create and manage their custom subscription bundles.

What are Subscription Bundles (Build-a-Box)? Subscription bundles allow customers to create personalized subscription boxes by selecting multiple products from a curated collection. Instead of subscribing to a fixed product, customers build their own custom bundle that gets delivered on a recurring basis. This is perfect for coffee subscriptions, snack boxes, beauty boxes, supplement packs, and any product category where variety and personalization drive customer satisfaction.

Bundle Configuration Settings:

1. Product Selection Rules:

• Minimum number of products required in bundle
• Maximum number of products allowed in bundle
• Product categories available for selection
• Variant selection constraints
• Quantity limits per product
• Total bundle value constraints (min/max price)

2. Bundle Behavior:

• Allow customers to modify bundle between orders
• Lock bundle after first order
• Enable automatic product rotation
• Allow quantity adjustments
• Substitution rules when products unavailable

3. Pricing & Discounts:

• Bundle pricing model (fixed price vs. sum of products)
• Volume discounts based on bundle size
• Tiered pricing structures
• Promotional pricing for bundles
• Discount application rules

4. UI/UX Settings:

• Bundle builder interface layout
• Product display format (grid/list)
• Images and descriptions shown
• Filter and search options
• Preview and summary display
• Mobile responsiveness settings

5. Fulfillment Options:

• Bundling method (ship together vs. separate)
• Packaging preferences
• Custom box selection
• Gift message options
• Delivery instructions

6. Customer Experience:

• Welcome flow for new bundle subscribers
• Modification window before each order
• Reminder notifications to update bundle
• Recommendation engine settings
• Save favorite bundle configurations

Common Bundle Types:

Coffee Subscription Bundle:

• Select 3-5 coffee varieties per month
• Choose roast levels, origins, or flavors
• Option to rotate selections monthly
• Fixed price regardless of selection

Snack Box Bundle:

• Choose 10 items from 50+ snacks
• Category limits (e.g., max 3 sweet, 7 savory)
• Dietary restriction filters (vegan, gluten-free)
• Tiered pricing based on bundle size

Beauty Box Bundle:

• Select products from skincare, makeup, haircare categories
• Minimum 5 products, maximum 8 products
• Total value must be between $40-$100
• Can swap 2 products each month

Vitamin/Supplement Bundle:

• Build personalized supplement pack
• Health goal-based recommendations
• Compatibility checking (ingredient interactions)
• Fixed monthly price for up to 5 supplements

Use Cases:

• Configure bundle builder in customer portal
• Validate customer bundle selections against rules
• Display bundle configuration options during signup
• Integrate with checkout to show bundle pricing
• Build custom bundle management interfaces
• Sync bundle settings with mobile apps
• Generate bundle recommendation algorithms

Important Notes:

• Settings apply to all subscription bundles in the shop
• Changes affect new bundles immediately
• Existing bundles maintain their original configuration unless migrated
• Product availability is checked in real-time during bundle creation
• Bundle modifications may have cutoff times before order processing

Best Practices:

• Set reasonable min/max limits to balance choice and complexity
• Provide clear guidance on bundle building process
• Use category limits to ensure variety
• Enable modification windows to boost engagement
• Offer curated bundle templates as starting points
• Implement substitution logic for out-of-stock items
• Test bundle builder UX across devices

Authentication: Requires valid X-API-Key header