Skip to main content
GET
/
api
/
external
/
v2
/
product-swaps
/
{id}
Get a specific product swap by ID
curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/product-swaps/{id}
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://developers.appstle.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-API-Key
string

Path Parameters

​
id
integer<int64>
required

Response

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