How to use the BYOB Public API?

The BYOB Public API allows developers to retrieve and manage BYOB bundle configurations programmatically.

You can use it to build internal tools, scripts, CLI tools, automations, or AI integrations without manually managing every bundle through the BYOB app.

Who can use the Public API?

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

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

Public API access is tied to your current BYOB subscription.

What can I do with the API?

The Public API supports the core bundle management workflow.

You can:

• List bundles in your store
• Retrieve a bundle configuration
• Find a bundle using its Shopify product ID
• Create a new bundle
• Update an existing bundle

This is particularly useful if your store manages many bundles or frequently creates similar bundle configurations.

For example, you could retrieve an existing bundle, modify its products or settings, and use that configuration to create another bundle.

How to get started

Public API access is managed inside the BYOB app.

Go to:

BYOB → Settings → Developer Access

From the Developer Access page, you can:

• Create API keys
• Manage existing API keys
• Access the API documentation

The API documentation contains the latest endpoints, authentication requirements, request and response formats, validation rules, error responses, and examples.

We recommend accessing the documentation through the BYOB app rather than using a bookmarked external documentation URL.

How do API keys work?

You need an API key to authenticate requests to the Public API.

When you create a new API key, it includes the permissions required to work with bundle data:

• bundle:read
• bundle:write

bundle:read allows the key to retrieve bundle information.

bundle:write allows the key to perform supported create and update operations.

Keep your API key secure

An API key should be treated like a password.

Do not expose your API key in:

• Storefront JavaScript
• Client-side applications
• Public Git repositories
• Screenshots
• Public documentation
• Source code that may be shared publicly

We recommend storing API keys in an environment variable or secret manager on your server.

If you believe an API key has been exposed, revoke it from Developer Access and create a new one.

Why should I use the API instead of modifying BYOB metafields?

Some BYOB configuration data may be visible through Shopify product metafields.

You should not modify BYOB-managed metafields directly.

BYOB stores bundle configuration in our backend as well as Shopify. Directly modifying the metafields can cause the Shopify data and BYOB backend data to become inconsistent.

If you need to create or update bundle configurations programmatically, use the Public API instead.

Listing bundles

You can retrieve the bundles belonging to your store through the Public API.

This can be useful for:

• Auditing bundle configurations
• Building internal management tools
• Checking configuration problems
• Comparing bundles
• Synchronizing bundle information with another system

Refer to the API documentation inside BYOB for the latest endpoint and response format.

Retrieving a bundle

You can retrieve the configuration of an individual bundle through the API.

Bundles can also be located using their associated Shopify product information.

This can be useful if your own system primarily works with Shopify product IDs rather than BYOB bundle IDs.

Creating bundles

The Public API allows developers to create new bundles using structured JSON data.

A common workflow could be:

1. Retrieve an existing bundle
2. Use its configuration as a starting point
3. Change the relevant products or settings
4. Send the updated configuration to the create endpoint

This can significantly reduce repetitive work when managing similar bundles.

Updating bundles

Existing bundle configurations can also be updated through the Public API.

Using the API ensures that BYOB can process the changes and keep the relevant bundle data synchronized.

Avoid directly modifying BYOB-managed Shopify metafields as an alternative to the update API.

What happens if I downgrade my BYOB plan?

Public API access requires the Advance or Plus plan.

If your store downgrades to Basic or Standard, existing API keys will no longer be able to access the Public API.

The API keys do not need to be deleted simply because the plan has changed.

If the store later returns to an eligible plan, API access can be restored according to the current Developer Access settings.

What happens if BYOB is uninstalled?

When BYOB is uninstalled from your Shopify store, Public API access for the store is revoked.

Existing API keys will no longer provide access to the store's BYOB data.

If BYOB is installed again later, create new API credentials if required.

Can I use the API with AI agents?

Yes.

The BYOB Public API is a REST API and can be used by developer tools and AI systems that can work with HTTP APIs.

You can build integrations such as:

• Python scripts
• JavaScript or TypeScript applications
• CLI tools
• Internal admin tools
• Workflow automations
• AI agents
• MCP servers

For example, an internal tool or AI agent could retrieve your bundle configurations, compare them, find potential configuration issues, or help create similar bundles.

Does BYOB provide an MCP server?

BYOB currently provides the Public API as the programmatic interface for bundle management.

If your workflow uses MCP, you can build an MCP server or another integration on top of the Public API.

Where can I find the API documentation?

Open the BYOB app and go to:

Settings → Developer Access → API documentation

Use the link provided inside the app to access the latest technical documentation for the Public API.