Skip to main content
This guide walks through the fastest path to make your first Appstle Bundles API call.

Prerequisites

  • An active Appstle Bundles installation on your Shopify store, with the API access add-on on your plan (see Authentication)
  • Access to the Appstle admin panel
  • An API key for server-side Admin API calls

Step 1 — Get your API key

1

Open API Key Access

In your Appstle admin panel, go to Settings → API Key Access.
2

Copy the key

Copy the value in the API Key field.
3

Export the key locally

Store the key as an environment variable:

Step 2 — Read bundle rules

Call GET /api/external/bundle-rules to retrieve configured bundle rules.
The key identifies your store, so the call has no shop parameter. See Sending the API key. A successful call looks like this, trimmed to one rule:
The response is a JSON array of bundle rules, newest first. Each rule has many more fields than shown here: see the API reference for the full schema. The x-total-count header gives the total number of rules.

Step 3 — Explore discount and build-a-box rules

Use the related Admin API endpoints when you need more specific rule types:

Step 4 — Review storefront endpoints

For customer-facing build-a-box flows, use the Storefront API section in the sidebar. It includes endpoints for fetching build-a-box configuration and generating bundle discounts by token.
Storefront API calls depend on Appstle’s storefront flow and tokenized build-a-box URLs. Use the generated API reference for exact parameters and response schemas.

What to build next

Full integration guide

Review Admin and Storefront endpoint categories for production integrations.

API reference

Use the Bundles tab sidebar to inspect every endpoint, parameter, and response schema.