Introducing the BYOB Public API: Manage Your Bundles Programmatically

We’re excited to introduce the BYOB Public API, giving developers and technical teams a new way to manage BYOB bundles programmatically.

Until now, most bundle configuration has been managed directly inside the BYOB app. That works well for most stores, but some merchants manage many bundles or use internal tools, scripts, and workflows.

The Public API opens up a new way to work with BYOB.

Why We Built the Public API

As stores grow, managing bundles manually can become repetitive.

For example, you may want to:

• Audit bundle configurations across your store
• Retrieve bundle settings for internal tools
• Find bundles by their Shopify product ID
• Update bundles automatically
• Create similar bundles from an existing configuration
• Build your own CLI, automation, or AI agent around BYOB

Instead of manually opening each bundle inside the app, developers can now work directly with BYOB through an authenticated REST API.

What Can You Do With the API?

The first version of the API focuses on the core bundle management workflow.

List your bundles

Retrieve the bundles configured in your store and inspect their current settings.

This can be useful for reporting, audits, synchronization, and internal tools.

Retrieve a bundle

Fetch the configuration of an individual bundle.

Bundles can also be located using their associated Shopify product information, making it easier to connect BYOB with your existing Shopify tooling.

Create bundles

Create a new bundle from a JSON payload.

This makes workflows such as creating similar bundles for different products, teams, locations, or campaigns much easier to automate.

Update bundles

Existing bundle configurations can also be updated through the API.

Instead of modifying BYOB-managed metafields directly, your integration can make changes through BYOB so that the bundle configuration remains synchronized with our backend.

Built for Developer Workflows

The API uses standard REST conventions and JSON responses, so you can use it from almost any programming language or automation platform.

You can use the API with:

• Python
• JavaScript / TypeScript
• CLI tools
• Internal admin applications
• Workflow automation
• AI agents

You can also build your own MCP server on top of the API if you want to expose BYOB bundle management to an AI assistant.

API Key Authentication

Public API access is protected using API keys.

API credentials are managed separately from normal BYOB storefront functionality, so you can give your development tools access without exposing your Shopify or BYOB account credentials.

API keys should always be treated as secrets and stored securely on your server or in an environment variable.

Plan Availability

The BYOB Public API is available on the Advance and Plus plans.

If your store is currently using the Basic or Standard plan, you will need to upgrade to an eligible plan before using the Public API.

API access is tied to your current BYOB subscription. If a store moves to a plan that does not include Public API access, existing API keys will no longer be able to access the API.

A Foundation for AI and Automation

One reason we built the Public API is that the way developers interact with software is changing.

Increasingly, configuration work is being handled through scripts, internal tools, AI coding agents, and MCP-compatible assistants instead of entirely through a graphical admin interface.

The BYOB Public API provides the foundation for these workflows.

For example, an AI agent could help you:

• Find bundles with incorrect configurations
• Compare multiple bundle setups
• Duplicate a bundle and modify selected products
• Audit pricing and bundle rules
• Create or update bundles from structured instructions

The API remains the source of truth, while developers are free to build whatever interface or automation they prefer on top of it.

Who Is This For?

Most BYOB merchants will continue managing their bundles through the BYOB app.

The Public API is mainly designed for stores and developers who:

• Manage many bundles
• Update bundle configurations frequently
• Have their own development team or technical workflow
• Need to automate repetitive bundle management
• Want to integrate BYOB into internal systems
• Want to connect BYOB with AI agents or developer tools

Getting Started

If your store is on the Advance or Plus plan, you can manage Public API access directly inside BYOB.

Go to:

BYOB → Settings → Developer Access

From there, you can create an API key and open the API documentation to view the latest endpoints, authentication requirements, request and response formats, validation rules, and examples.

We intentionally recommend accessing the API documentation through the BYOB app so developers always reach the current documentation from the correct store context.

As this is the first version of the Public API, we’d especially like to hear how developers are using it and which endpoints would be most useful next.

If you’re building an integration, CLI, automation, or AI workflow with BYOB, feel free to reach out to us.

We’d love to hear what you build. 🚀