Updates an existing product swap automation rule for the authenticated shop. Use this endpoint to modify swap configurations, change source/destination products, adjust timing, or update discount handling.
Required Fields:
Updatable Fields:
Impact of Updates:
Authentication: Requires valid X-API-Key header
curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/product-swaps \
--header 'Content-Type: application/json' \
--data '
{
"shop": "example-shop"
}
'{
"id": 10782,
"shop": "example-shop",
"sourceVariants": "[{\"id\":12345,\"displayName\":\"test-product\",\"imageSrc\":\"https://test.com/image.png\",\"quantity\":2}]",
"destinationVariants": "[{\"id\":67890,\"displayName\":\"test-product\",\"imageSrc\":\"https://test.com/image.png\",\"quantity\":2}]",
"updatedFirstOrder": false,
"checkForEveryRecurringOrder": false,
"name": "swap test",
"changeNextOrderDateBy": null,
"forBillingCycle": 2,
"carryDiscountForward": false,
"ruleSequence": 0,
"stopSwapEmails": false,
"discountCarryForward": "NONE"
}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.
ProductSwapDTO payload
NONE, EXISTING_PLAN, PRODUCT_PLAN, PRODUCT_THEN_EXISTING Product swap updated successfully
NONE, EXISTING_PLAN, PRODUCT_PLAN, PRODUCT_THEN_EXISTING curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/product-swaps \
--header 'Content-Type: application/json' \
--data '
{
"shop": "example-shop"
}
'{
"id": 10782,
"shop": "example-shop",
"sourceVariants": "[{\"id\":12345,\"displayName\":\"test-product\",\"imageSrc\":\"https://test.com/image.png\",\"quantity\":2}]",
"destinationVariants": "[{\"id\":67890,\"displayName\":\"test-product\",\"imageSrc\":\"https://test.com/image.png\",\"quantity\":2}]",
"updatedFirstOrder": false,
"checkForEveryRecurringOrder": false,
"name": "swap test",
"changeNextOrderDateBy": null,
"forBillingCycle": 2,
"carryDiscountForward": false,
"ruleSequence": 0,
"stopSwapEmails": false,
"discountCarryForward": "NONE"
}