Update an existing product swap automation

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.

Full behavior, validation rules, and side effects

Required Fields:

• id: The product swap ID to update
• shop: Your Shopify shop domain (must match authenticated shop)

Updatable Fields:

• sourceVariants: JSON string of variants to swap FROM
• destinationVariants: JSON string of variants to swap TO
• name: Descriptive name for this swap rule
• forBillingCycle: Specific cycle number when swap occurs (null for recurring)
• checkForEveryRecurringOrder: If true, applies swap to every order
• updatedFirstOrder: If true, can affect the first subscription order
• changeNextOrderDateBy: Days to adjust next order date after swap
• discountCarryForward: How to handle discounts (NONE, PERCENTAGE, FIXED_AMOUNT, PRICE)
• carryDiscountForward: Legacy boolean field (use discountCarryForward instead)
• stopSwapEmails: If true, suppresses customer notification emails
• ruleSequence: Priority order (lower number = higher priority)

Impact of Updates:

• Changes apply to future orders immediately
• Past orders and already-swapped products are not affected
• If changing forBillingCycle, recalculates which subscriptions are affected
• Variant data is automatically enriched from Shopify on update

Authentication: Requires valid X-API-Key header

PUT /api/external/v2/product-swaps

Update an existing product swap automation

cURL

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/product-swaps \
  --header 'Content-Type: application/json' \
  --data '
{
  "shop": "example-shop"
}
'

200

{
  "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"
}

Headers

X-API-Key · string

Body

application/json

ProductSwapDTO payload

shop · string · required

id · integer<int64>

sourceVariants · string

destinationVariants · string

updatedFirstOrder · boolean

checkForEveryRecurringOrder · boolean

name · string

changeNextOrderDateBy · integer<int32>

forBillingCycle · integer<int32>

carryDiscountForward · boolean

ruleSequence · integer<int32>

stopSwapEmails · boolean

discountCarryForward · enum<string>

Available options: NONE, EXISTING_PLAN, PRODUCT_PLAN, PRODUCT_THEN_EXISTING

Response

200

application/json

Product swap updated successfully

shop · string · required

id · integer<int64>

sourceVariants · string

destinationVariants · string

updatedFirstOrder · boolean

checkForEveryRecurringOrder · boolean

name · string

changeNextOrderDateBy · integer<int32>

forBillingCycle · integer<int32>

carryDiscountForward · boolean

ruleSequence · integer<int32>

stopSwapEmails · boolean

discountCarryForward · enum<string>

Available options: NONE, EXISTING_PLAN, PRODUCT_PLAN, PRODUCT_THEN_EXISTING