Skip to content
/Product Swap Rules

External (0.0.1)

Download OpenAPI description
admin-api-swagger.json
admin-api-swagger.yaml
Languages
Servers
https://membership-admin.appstle.com

Shipping & Delivery Profiles

APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships

Operations

Customer Discount History

APIs for retrieving historical discount code usage and redemption information for membership contracts

Operations

Cancellation Flow Configuration

APIs for managing membership cancellation flow settings including retention offers, survey questions, and cancel confirmation screens

Operations

Billing & Orders

APIs for managing membership billing attempts, recurring orders, payment retries, order history, and order skipping

Operations

One-Time Add-Ons

APIs for managing one-time product additions to upcoming subscription orders, including adding, retrieving, and removing one-off items

Operations

Membership Plans

APIs for managing membership/subscription plan groups, including creating plans, configuring discounts, billing intervals, and assigning products to plans

Operations

Product Bundles

APIs for managing subscription product bundles, bundle configurations, item grouping, and bundle-specific discount codes

Operations

Custom CSS Styling

APIs for retrieving custom CSS styles applied to subscription widgets and customer portal for theme customization

Operations

Customer Portal Configuration

APIs for managing customer portal settings including UI customization, text labels, feature toggles, and branding options for the member self-service portal

Operations

Membership Contracts

APIs for managing membership/subscription contracts including creation, updates, status changes, line items, discounts, and billing operations

Operations

Bundle Settings

APIs for managing subscription bundle configuration settings including bundle behavior, pricing rules, and display options

Operations

Customer Payment Methods

APIs for managing customer payment methods, payment tokens, and payment method retrieval for subscriptions

Operations

Product Swap Rules

APIs for retrieving product swap/substitution options allowing members to exchange subscription items based on configured swap rules and variant groups

Operations

Get product swap options for subscription items

Request

Retrieves available product swap/substitution options for specified variants based on configured swap rules. Returns multiple levels of swap suggestions allowing members to exchange products in their subscriptions.

Key Features:

  • Variant-Based Swaps: Get swap options for specific product variants
  • Multi-Level Suggestions: Returns up to 4 levels of swap alternatives
  • Quantity Preservation: Maintains quantities when suggesting swaps
  • Recurring Order Rules: Only returns swaps configured for every recurring order
  • Group-Based Matching: Uses variant groups to find compatible swaps
  • Product Enrichment: Includes product details (title, price, images)

How Swap Rules Work:

  1. Merchant configures swap rules defining which products can substitute others
  2. Rules are organized by variant groups (e.g., coffee roasts, tea flavors)
  3. Each rule specifies "from" variants and "to" variants
  4. Rules can be limited to specific subscription frequencies or all orders
  5. Members can swap products within the allowed groups

Request Structure:

  • Variant Quantity List: Array of variant IDs with quantities
  • Each entry contains variant ID and quantity
  • System finds swap options for all provided variants

Response Structure:

  • Returns nested list of swap options (up to 5 levels)
  • Level 0: Original variants (as provided in request)
  • Levels 1-4: Progressive swap suggestions
  • Each level contains variant IDs, quantities, titles, prices, images
  • Variants appear with full Shopify product data

Use Cases:

  • Display product swap options in customer portal
  • Allow members to switch between flavor/size variants
  • Build custom product selection interfaces
  • Enable seasonal product swaps (summer/winter varieties)
  • Offer alternative products when items are out of stock
  • Let members customize subscriptions within allowed product groups

Example Scenario: Member has "Dark Roast Coffee (12oz)" in subscription. API returns:

  • Level 0: Dark Roast Coffee 12oz (original)
  • Level 1: Medium Roast Coffee 12oz, Light Roast Coffee 12oz
  • Level 2: Dark Roast Coffee 16oz, Decaf Dark Roast 12oz
  • Level 3: Espresso Blend 12oz, French Roast 12oz
  • Level 4: Additional variants based on swap rules

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

Query
api_keystring

API Key (Deprecated - Use Header X-API-Key instead)

Headers
X-API-Keystring

API Key for authentication (Preferred method - use this instead of api_key parameter)

Bodyapplication/jsonrequired

List of variants with quantities to find swap options for

variantQuantityListArray of objects(VariantQuantity)
curl -i -X POST \
  'https://membership-admin.appstle.com/api/external/v2/product-swaps-by-variant-groups?api_key=string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: string' \
  -d '{
    "variantQuantityList": [
      {
        "variantId": 123456,
        "quantity": 2
      },
      {
        "variantId": 789012,
        "quantity": 1
      }
    ]
  }'

Responses

Swap options successfully retrieved with up to 5 levels of suggestions

Bodyapplication/json
arrays
Response
application/json
[]

Subscription Contract Management

Operations

Subscription Billing

Operations

Billing Attempts

Operations