Get a specific product swap by ID

Retrieves detailed information about a specific product swap automation configuration. This endpoint returns complete details about the source products, destination products, swap triggers, and all associated settings.

Full behavior, validation rules, and side effects

Response Details:

• Complete swap configuration
• Source product variants with images and quantities
• Destination product variants with images and quantities
• Billing cycle triggers and conditions
• Discount carry-forward settings
• Email notification preferences
• Swap status and history

Source and Destination Variants: Both source and destination variants are returned as JSON strings containing:

• Variant ID
• Display name/title
• Product image URL
• Quantity to swap
• Product metadata

Swap Timing:

• forBillingCycle: If set, swap occurs at this specific cycle number
• checkForEveryRecurringOrder: If true, swap happens on every order
• updatedFirstOrder: If true, can affect the initial subscription order

Discount Handling:

• NONE: No discount carried forward
• PERCENTAGE: Percentage discount is maintained
• FIXED_AMOUNT: Fixed amount discount is maintained
• PRICE: Specific price point is maintained

Authentication: Requires valid X-API-Key header

GET /api/external/v2/product-swaps/{id}

Get a specific product swap by ID

cURL

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

200

{
  "id": 10782,
  "shop": "example-shop.myshopify.com",
  "sourceVariants": "[{\"id\":12345,\"displayName\":\"Summer Blend Coffee - 12oz\",\"imageSrc\":\"https://cdn.shopify.com/files/1/0000/0000/products/summer-blend.jpg\",\"quantity\":2,\"price\":\"29.99\"}]",
  "destinationVariants": "[{\"id\":67890,\"displayName\":\"Fall Blend Coffee - 12oz\",\"imageSrc\":\"https://cdn.shopify.com/files/1/0000/0000/products/fall-blend.jpg\",\"quantity\":2,\"price\":\"29.99\"}]",
  "updatedFirstOrder": false,
  "checkForEveryRecurringOrder": false,
  "name": "Seasonal Coffee Rotation",
  "description": "Automatically swap to seasonal blend at cycle 4",
  "forBillingCycle": 4,
  "carryDiscountForward": true,
  "stopSwapEmails": false,
  "discountCarryForward": "PERCENTAGE",
  "active": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "contractsAffected": 145
}

Headers

X-API-Key · string

Path Parameters

id · integer<int64> · required

Response

200

application/json

Product swap successfully retrieved

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