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:
How Swap Rules Work:
Request Structure:
Response Structure:
Use Cases:
Example Scenario: Member has “Dark Roast Coffee (12oz)” in subscription. API returns:
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
curl --request POST \
--url https://membership-admin.appstle.com/api/external/v2/product-swaps-by-variant-groups \
--header 'Content-Type: application/json' \
--data '
{
"variantQuantityList": [
{
"variantId": 123456,
"quantity": 2
},
{
"variantId": 789012,
"quantity": 1
}
]
}
'"<array>"Documentation Index
Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
API Key for authentication (Preferred method - use this instead of api_key parameter)
API Key (Deprecated - Use Header X-API-Key instead)
List of variants with quantities to find swap options for
Show child attributes
Swap options successfully retrieved with up to 5 levels of suggestions
curl --request POST \
--url https://membership-admin.appstle.com/api/external/v2/product-swaps-by-variant-groups \
--header 'Content-Type: application/json' \
--data '
{
"variantQuantityList": [
{
"variantId": 123456,
"quantity": 2
},
{
"variantId": 789012,
"quantity": 1
}
]
}
'"<array>"