GET /ecommerceProductVariations — List ecommerce product variations
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns the affiliate's ecommerce product variations. Use this to look up the id of a variation before referencing it as a variationId when creating or updating a subscription (see PUT /v2/ecommerceSubscriptions/{id}).
PathThis endpoint is on the base API path (
/ecommerceProductVariations), not under/v2.
Results are scoped to the authenticated affiliate automatically.
Query parameters
| Parameter | Type | Description |
|---|---|---|
parentProduct | string | Filter to variations of a single parent product. |
productVariation | string | Filter by the mapped internal product variation ID. |
name | string | Filter by variation name. |
page | number | Page number for pagination. |
limit | number | Number of items per page. |
Response 200
200{
"count": 2,
"productVariations": [
{
"id": "epvt::sema-month-1-intro",
"name": "Semaglutide — Month 1 Intro",
"sku": "SEMA-M1",
"regularPrice": 149,
"salePrice": null,
"onSale": false,
"currency": "USD",
"image": null,
"productType": "SUBSCRIPTION_VARIABLE",
"ecommercePlatform": "telegra-commerce",
"ecommerceVariationId": "1201",
"mappedProductVariation": {
"id": "pvt::4b3f804b-…",
"name": "Semaglutide"
},
"createdAt": "2026-01-01T12:00:00.000Z",
"updatedAt": "2026-01-01T12:00:00.000Z"
},
{
"id": "epvt::sema-month-2plus",
"name": "Semaglutide — Month 2+",
"sku": "SEMA-M2",
"regularPrice": 299,
"salePrice": null,
"onSale": false,
"currency": "USD",
"image": null,
"productType": "SUBSCRIPTION_VARIABLE",
"ecommercePlatform": "telegra-commerce",
"ecommerceVariationId": "1202",
"mappedProductVariation": {
"id": "pvt::4b3f804b-…",
"name": "Semaglutide"
},
"createdAt": "2026-01-01T12:00:00.000Z",
"updatedAt": "2026-01-01T12:00:00.000Z"
}
]
}The id field (e.g. epvt::sema-month-2plus) is the value you pass as variationId when setting a subscription's productVariations.
productType is one of ONE_TIME, SUBSCRIPTION_FIXED, or SUBSCRIPTION_VARIABLE. Use a subscription type (SUBSCRIPTION_FIXED or SUBSCRIPTION_VARIABLE) for variations billed on a subscription. mappedProductVariation is the internal clinical product variation this ecommerce variation is linked to (or null if unmapped).
Required role
Affiliate token required. Results are automatically scoped to the authenticated affiliate.
default