Build bundles with your own storefront UI
Prefer your own design over Appstle’s built-in widgets? Read the bundle rule over the API, render your own selector, and let Appstle’s automatic discount apply the savings at checkout. Start with the headless overview.
Available APIs
Appstle Bundles exposes two REST API surfaces. Pick the one that matches where your code runs:- Admin API — server-side, authenticated with
X-API-Key. For reading configured bundle and discount rules from a backend service. Browse the full reference under Admin API in the sidebar. - Storefront API — customer-facing, accessed through Shopify App Proxy. For rendering build-a-box experiences and generating bundle discounts. Browse the full reference under Storefront API in the sidebar.
Which API should you use?
- Use the Admin API when…
- Use the Storefront API when…
- You need to read configured bundle rules from a backend service
- You need to read bundle discount rules
- You are syncing build-a-box rules into another system
- You are building reporting, auditing, or merchant-support tooling
- Your code runs anywhere outside a customer’s browser on the storefront
Admin API requests require an
X-API-Key header. Copy your store’s key in the Appstle dashboard under Settings → API Key Access. Never expose keys in client-side code.Key features
Bundle rule lookup
Read active bundle rules and discount rules for a store so external systems can mirror merchant configuration.
Build-a-Box experiences
Fetch build-a-box configuration by token or product handle and render bundle selectors in custom storefronts.
Bundle discounts
Generate bundle and shipping discounts for eligible build-a-box selections.
Storefront activity
Record storefront visitor activity for Appstle-powered bundle widgets and customer-facing flows.
Base URL
All Admin API endpoints use:HTTP status codes
All API responses use standard HTTP status codes.
On the Admin API, an unexpected server error returns
500 with Content-Type: application/problem+json. The body has status 500 and a generic detail message that doesn’t say what failed. Check the request against the API reference first. If it’s correct, wait a few seconds and send it once more: every Bundles Admin API call is a GET, so a second try can’t change any data. Don’t retry in a loop: an endpoint that keeps failing is rate limited. If the second try fails too, contact support@appstle.com with the store’s myshopify.com domain, the request path and the time of the call.
A missing or invalid key, or a plan without API access, returns this response:
500 has Shopify’s HTML error page as its body, not JSON, and a path or method that no endpoint has returns 403, not 404 or 405. See Storefront API errors.
Next steps
Authentication
Create an API key and learn how to authenticate server-side Bundles API calls.
Quickstart
Get an API key and make your first bundle-rule request.
Integration guide
Review the main Admin and Storefront endpoint categories.
API changelog
Dated changes to the Admin API, Storefront API and JavaScript events, with what to do about each.