# Appstle - [Subscriptions (260 pages)](https://developers.appstle.com/_llms/subscriptions.md): Recurring orders, selling plans, and the customer portal ## Loyalty ### Get Started - [Appstle Loyalty: Points, VIP Tiers & Referrals](https://developers.appstle.com/loyalty/introduction.md): Appstle Loyalty provides Admin and Storefront REST APIs to build points programs, VIP tiers, and referrals on Shopify. Learn which API fits your use case. - [Authenticate with the Appstle Loyalty API](https://developers.appstle.com/loyalty/authentication.md): Create an API key in the Appstle dashboard, pass it in the X-API-Key header on every request, and manage up to 10 keys per store with per-key revocation. - [Get started with Appstle Loyalty API](https://developers.appstle.com/loyalty/quickstart.md): Create an API key, retrieve a customer's loyalty profile with points and VIP tier, then credit points to their account — all in under five minutes. ### Guides - [Appstle Loyalty third-party integration guide](https://developers.appstle.com/loyalty/integration-guide.md): Build a production integration with Appstle Loyalty. Covers authentication, base URL, point management, enrollment, rewards, store credits, and partner connections. - [Automate loyalty with Shopify Flow](https://developers.appstle.com/loyalty/shopify-flow.md): Automate loyalty with Appstle's native Shopify Flow triggers and actions. Award points, assign VIP tiers, and issue store credits — no API code required. - [Shopify metafields and tags for Appstle Loyalty](https://developers.appstle.com/loyalty/metafields-and-tags.md): Shopify metafields and tags set by Appstle Loyalty: loyalty profiles, reward codes, product reviews, VIP tags, and referral tags — with schema examples. ### Partner Integration - [Partner Integration Framework overview](https://developers.appstle.com/loyalty/partner-framework-overview.md): How the Appstle Loyalty Partner Integration Framework works — one handshake per merchant, a scoped API token, no API plan required, automatic revocation. - [Partner Integration Framework](https://developers.appstle.com/loyalty/partner-integration.md): Build a seamless, zero-configuration integration between your app and Appstle Loyalty. Scoped API tokens, nonce handshake, and merchant-approved connections. ### Webhooks - [Appstle Loyalty webhook events and setup](https://developers.appstle.com/loyalty/webhooks.md): Set up Appstle Loyalty webhooks to receive real-time notifications for point transactions, VIP tier changes, and referrals — with Svix signature verification. ### Admin API #### Points & Earn Rules - [Add store credits to customer account](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/add-store-credits-to-customer-account.md) - [Add points to customer account](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/add-points-to-customer-account.md) - [Approve pending point transactions](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/approve-pending-point-transactions.md) - [Get all point earning rules](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/get-all-point-earning-rules.md) - [Get customer point transaction history](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/get-customer-point-transaction-history.md) - [Remove points from customer account](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/remove-points-from-customer-account.md) - [Get top customers by points earned](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/get-top-customers-by-points-earned.md) #### Redemptions & Discount Codes - [Check discount code validity](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/check-discount-code-validity.md) - [Get all point redemption rules](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/get-all-point-redemption-rules.md) - [Redeem customer points for rewards](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/redeem-customer-points-for-rewards.md) - [Update discount code status](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/update-discount-code-status.md) - [Update discount code status (legacy endpoint)](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/update-discount-code-status-legacy-endpoint.md) #### Customer Enrollment & Profile - [Get customer loyalty details](https://developers.appstle.com/loyalty-admin-api/customer-enrollment-&-profile/get-customer-loyalty-details.md) - [Enroll customer in loyalty program](https://developers.appstle.com/loyalty-admin-api/customer-enrollment-&-profile/enroll-customer-in-loyalty-program.md) - [Update customer birth date](https://developers.appstle.com/loyalty-admin-api/customer-enrollment-&-profile/update-customer-birth-date.md) #### Storefront Widgets & Labels - [List storefront widget label translations](https://developers.appstle.com/loyalty-admin-api/storefront-widgets-&-labels/list-storefront-widget-label-translations.md) ### Storefront API #### Referrals - [Generate customer referral URL](https://developers.appstle.com/loyalty-storefront-api/referrals/generate-customer-referral-url.md) - [Get customer referral history](https://developers.appstle.com/loyalty-storefront-api/referrals/get-customer-referral-history.md) - [Accept referral offer (GET)](https://developers.appstle.com/loyalty-storefront-api/referrals/accept-referral-offer-get.md) - [Accept referral offer (POST)](https://developers.appstle.com/loyalty-storefront-api/referrals/accept-referral-offer-post.md) - [Send customer referral email](https://developers.appstle.com/loyalty-storefront-api/referrals/send-customer-referral-email.md) #### Points & Earn Rules - [Claim social media reward points](https://developers.appstle.com/loyalty-storefront-api/points-&-earn-rules/claim-social-media-reward-points.md) - [Track customer store visit](https://developers.appstle.com/loyalty-storefront-api/points-&-earn-rules/track-customer-store-visit.md) - [Get customer point transaction history](https://developers.appstle.com/loyalty-storefront-api/points-&-earn-rules/get-customer-point-transaction-history.md) #### Customer Enrollment & Profile - [Get customer loyalty information](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/get-customer-loyalty-information.md) - [Enable loyalty program for customer](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/enable-loyalty-program-for-customer.md) - [Enroll customer in loyalty program](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/enroll-customer-in-loyalty-program.md) - [Get logged-in customer ID](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/get-logged-in-customer-id.md) - [Sync customer metafield data](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/sync-customer-metafield-data.md) - [Update customer birth date](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/update-customer-birth-date.md) - [Update customer loyalty status](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/update-customer-loyalty-status.md) #### store-front-resource - [Get loyaltycpapinotification session](https://developers.appstle.com/loyalty-storefront-api/store-front-resource/get-loyaltycpapinotification-session.md) - [Post loyaltycpapisubmit review](https://developers.appstle.com/loyalty-storefront-api/store-front-resource/post-loyaltycpapisubmit-review.md) #### Reviews - [Get product reviews by product ID](https://developers.appstle.com/loyalty-storefront-api/reviews/get-product-reviews-by-product-id.md) - [Submit product review](https://developers.appstle.com/loyalty-storefront-api/reviews/submit-product-review.md) #### Redemptions & Discount Codes - [Redeem customer loyalty points](https://developers.appstle.com/loyalty-storefront-api/redemptions-&-discount-codes/redeem-customer-loyalty-points.md) #### Product Catalog - [Proxy a Shopify Storefront GraphQL request from the customer portal](https://developers.appstle.com/loyalty-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal.md) - [Memberships (118 pages)](https://developers.appstle.com/_llms/memberships.md): Membership plans, member perks, billing, and access control ## Bundles ### Get Started - [Appstle Bundles: Build-a-Box and Bundle Rules](https://developers.appstle.com/bundles/introduction.md): Appstle Bundles provides Admin and Storefront REST APIs to read bundle rules, power build-a-box experiences, and generate bundle discounts on Shopify. - [Authenticate with the Appstle Bundles API](https://developers.appstle.com/bundles/authentication.md): Create an Appstle API key and pass it in the X-API-Key header for Bundles Admin API requests. - [Get started with Appstle Bundles API](https://developers.appstle.com/bundles/quickstart.md): Create an API key, read bundle rules, and inspect build-a-box storefront endpoints. ### Guides - [Appstle Bundles integration guide](https://developers.appstle.com/bundles/integration-guide.md): Build a production integration with Appstle Bundles. Covers base URLs, authentication, bundle rules, build-a-box flows, and discount generation. ### Headless Integration - [Build bundles with your own storefront UI](https://developers.appstle.com/bundles/headless-overview.md): Run Appstle's fixed pricing, dynamic pricing, and volume discount bundles with a fully custom storefront. Read the configuration from Shopify metafields, render your own UI with Shopify's own APIs, and let Appstle's Shopify Function apply the discount — with little or no traffic to Appstle's servers… - [Fixed pricing bundle with a custom storefront](https://developers.appstle.com/bundles/fixed-pricing-bundle.md): Sell a curated set of products for one fixed total price using your own storefront UI. Read the rule, render a selector, add to cart with Appstle's bundle attributes, and let the automatic discount price the set. - [Dynamic pricing bundle with a custom storefront](https://developers.appstle.com/bundles/dynamic-pricing-bundle.md): Offer a build-your-own bundle that applies a percentage or fixed-amount discount to the running total, using your own storefront UI and Appstle's automatic discount. - [Volume discount bundle with a custom storefront](https://developers.appstle.com/bundles/volume-discount-bundle.md): Run tiered 'buy more, save more' discounts based on quantity or spend, using your own storefront UI and Appstle's automatic discount. ### Partner Integration - [Partner Integration Framework overview](https://developers.appstle.com/bundles/partner-framework-overview.md): How the Appstle Bundles Partner Integration Framework works — one handshake per merchant, a scoped API token, no API plan required, automatic revocation. - [Partner Integration Framework](https://developers.appstle.com/bundles/partner-integration.md): Build a zero-configuration integration between your app and Appstle Bundles, with scoped API tokens per merchant. ### Admin API #### Bundle Rules - [Get all bundle rules](https://developers.appstle.com/bundles-admin-api/bundle-rules/get-all-bundle-rules.md) - [Get build-a-box bundle rules](https://developers.appstle.com/bundles-admin-api/bundle-rules/get-build-a-box-bundle-rules.md) - [Get discount rules](https://developers.appstle.com/bundles-admin-api/bundle-rules/get-discount-rules.md) ### Storefront API #### auto-add-cart-rule-storefront-resource - [Post bundlesbbapiauto add cart rulesevaluate](https://developers.appstle.com/bundles-storefront-api/auto-add-cart-rule-storefront-resource/post-bundlesbbapiauto-add-cart-rulesevaluate.md) #### Build-a-Box - [Get build-a-box configuration by token](https://developers.appstle.com/bundles-storefront-api/build-a-box/get-build-a-box-configuration-by-token.md) - [Generate a build-a-box bundle discount](https://developers.appstle.com/bundles-storefront-api/build-a-box/generate-a-build-a-box-bundle-discount.md) - [Get build-a-box configuration by handle](https://developers.appstle.com/bundles-storefront-api/build-a-box/get-build-a-box-configuration-by-handle.md) - [Generate a build-a-box shipping discount](https://developers.appstle.com/bundles-storefront-api/build-a-box/generate-a-build-a-box-shipping-discount.md) - [Get single-product build-a-box configuration](https://developers.appstle.com/bundles-storefront-api/build-a-box/get-single-product-build-a-box-configuration.md) #### slider-cart-analytics-storefront-resource - [Record a batch of storefront slider cart analytics events](https://developers.appstle.com/bundles-storefront-api/slider-cart-analytics-storefront-resource/record-a-batch-of-storefront-slider-cart-analytics-events.md) #### Product Catalog - [Proxy a Shopify Storefront GraphQL request for bundle widgets](https://developers.appstle.com/bundles-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-for-bundle-widgets.md) - [Proxy a Shopify Storefront GraphQL request from the customer portal](https://developers.appstle.com/bundles-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal.md) #### Storefront - [Render the build-a-box storefront page](https://developers.appstle.com/bundles-storefront-api/storefront/render-the-build-a-box-storefront-page.md) - [Record a storefront visitor ping](https://developers.appstle.com/bundles-storefront-api/storefront/record-a-storefront-visitor-ping.md) ## OpenAPI Specs - [admin-api-swagger](/subscription/admin-api-swagger.json) - [storefront-api-swagger](/subscription/storefront-api-swagger.json) - [admin-api-swagger](/loyalty/admin-api-swagger.json) - [storefront-api-swagger](/loyalty/storefront-api-swagger.json) - [admin-api-swagger](/memberships/admin-api-swagger.json) - [storefront-api-swagger](/memberships/storefront-api-swagger.json) - [admin-api-swagger](/bundles/admin-api-swagger.json) - [storefront-api-swagger](/bundles/storefront-api-swagger.json) - [openapi](/api-reference/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Subscriptions (260 pages)](https://developers.appstle.com/_llms/subscriptions.md): Recurring orders, selling plans, and the customer portal - [Memberships (118 pages)](https://developers.appstle.com/_llms/memberships.md): Membership plans, member perks, billing, and access control This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.