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

Generates a discount code for a subscription bundle. This endpoint creates a Shopify discount code that can be applied to bundle subscriptions, typically used during the checkout process.

Discount Code Generation:

• Creates a unique discount code in Shopify
• Associates the discount with the bundle
• Configures discount rules and limitations
• Sets expiration dates if specified
• Applies usage limits if configured

Discount Configuration Options:

• Discount type (percentage, fixed amount, or free shipping)
• Discount value/amount
• Minimum purchase requirements
• Maximum usage count
• Expiration date
• Customer eligibility rules

Use Cases:

• Promotional campaigns for bundles
• Welcome discounts for new subscribers
• Loyalty rewards for existing customers
• Special offers and limited-time promotions
• Partner/affiliate discount codes

Important Notes:

• Discount codes are created in Shopify and follow Shopify's discount rules
• Codes can be single-use or multi-use depending on configuration
• Expired or depleted codes cannot be reused

Authentication: Requires valid X-API-Key header

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

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

Updates an existing Build-A-Box subscription bundle with new configuration settings, product selections, pricing rules, or other bundle attributes. This endpoint allows you to modify any aspect of a previously created bundle while maintaining its unique identifier and shop association.

What Can Be Updated:

• Bundle Information: Name, description, handle, and display settings
• Product Configuration: Available products, product pool, and selection rules
• Quantity Limits: Minimum and maximum product counts per box
• Pricing Settings: Pricing type, discount rules, and promotional offers
• Delivery Options: Subscription frequencies and delivery intervals
• Business Rules: Product combination rules, category restrictions
• Status: Active/inactive state for customer visibility
• Customization Options: Allow product swaps, one-time purchases

Update Behavior:

• The bundle ID must be provided in the request body
• Shop ownership is verified - you can only update bundles belonging to your shop
• All fields in the request body will update the corresponding bundle properties
• Partial updates are supported - only include fields you want to change
• The update is atomic - either all changes succeed or none are applied
• Existing subscriptions using this bundle are not automatically affected

Impact on Active Subscriptions:

• Changes to product availability affect future customer selections
• Pricing updates apply to new subscriptions but not existing ones by default
• Quantity limit changes are enforced on next customer modification
• Frequency changes only affect new subscriptions
• Deactivating a bundle prevents new subscriptions but maintains existing ones

Common Update Scenarios:

1. Add/Remove Products: Update the available product pool
2. Adjust Pricing: Change discount percentages or pricing models
3. Modify Limits: Update minimum/maximum product selection rules
4. Change Frequencies: Add or remove subscription interval options
5. Update Content: Modify bundle name, description, or images
6. Toggle Status: Activate or deactivate bundle availability
7. Refine Rules: Adjust product combination or category restrictions

Best Practices:

• Verify product availability before adding to the bundle
• Test pricing changes with sample calculations
• Communicate bundle changes to existing subscribers
• Use inactive status for testing changes before making them live
• Keep bundle handles consistent for external integrations
• Document major changes for customer support reference
• Consider seasonal or promotional updates to keep offerings fresh

Validation Rules:

• Bundle ID is required and must exist
• Shop must match the authenticated shop (cannot transfer bundles)
• All referenced products must be valid and available
• Minimum product count cannot exceed maximum product count
• Pricing values must be non-negative
• Bundle handle should remain unique across all bundles

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