Get all product swaps for a shop

Retrieves all configured product swap automations for the authenticated shop. Product swaps allow automatic replacement of products in subscription orders based on billing cycles or recurring schedules.

Full behavior, validation rules, and side effects

What are Product Swaps? Product swaps enable merchants to automatically replace products in subscription orders at specific billing cycles. This is useful for seasonal products, progression paths (e.g., beginner → intermediate → advanced), or variety subscriptions.

Key Features:

• View all configured swap automations
• See source and destination product mappings
• Check which billing cycles trigger swaps
• Identify recurring vs one-time swaps
• Review discount carry-forward settings

Swap Configuration Types:

• One-Time Swap: Occurs at a specific billing cycle
• Recurring Swap: Occurs at every order
• Conditional Swap: Based on billing cycle number

Use Cases:

• Seasonal product rotations (summer → fall → winter products)
• Subscription progression (trial → full product)
• Variety boxes with automatic product rotation
• Product lifecycle management in subscriptions
• A/B testing different products in subscriptions

Authentication: Requires valid X-API-Key header

GET /api/external/v2/product-swaps

Get all product swaps for a shop

cURL

curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/product-swaps

200

[
  {
    "id": 10782,
    "shop": "example-shop.myshopify.com",
    "sourceVariants": "[{\"id\":12345,\"displayName\":\"Summer Blend Coffee\",\"imageSrc\":\"https://cdn.shopify.com/image1.jpg\",\"quantity\":2}]",
    "destinationVariants": "[{\"id\":67890,\"displayName\":\"Fall Blend Coffee\",\"imageSrc\":\"https://cdn.shopify.com/image2.jpg\",\"quantity\":2}]",
    "updatedFirstOrder": false,
    "checkForEveryRecurringOrder": false,
    "name": "Seasonal Coffee Rotation",
    "forBillingCycle": 4,
    "carryDiscountForward": true,
    "stopSwapEmails": false,
    "discountCarryForward": "PERCENTAGE",
    "active": true,
    "createdAt": "2024-01-15T10:30:00Z"
  },
  {
    "id": 10783,
    "shop": "example-shop.myshopify.com",
    "sourceVariants": "[{\"id\":22222,\"displayName\":\"Beginner Kit\",\"imageSrc\":\"https://cdn.shopify.com/kit1.jpg\",\"quantity\":1}]",
    "destinationVariants": "[{\"id\":33333,\"displayName\":\"Advanced Kit\",\"imageSrc\":\"https://cdn.shopify.com/kit2.jpg\",\"quantity\":1}]",
    "updatedFirstOrder": false,
    "checkForEveryRecurringOrder": true,
    "name": "Monthly Variety Swap",
    "forBillingCycle": null,
    "carryDiscountForward": false,
    "stopSwapEmails": true,
    "discountCarryForward": "NONE",
    "active": true
  }
]

Headers

X-API-Key · string

Query Parameters

ruleName · string

sourceVariants · string

destinationVariants · string

Response

200

application/json

Successfully retrieved product swaps

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