Get product variants associated with a selling plan

Get product variants associated with a selling plan

get

Retrieve product variants associated with a selling plan, including their preorder details and sales metrics.

Filtering behavior:

• No parameters: Returns all product variants in the selling plan

• shopify_product_id: Returns all variants for that specific product

• shopify_variant_id: Returns only that specific variant (single object response)

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Path parameters

idstringRequired

Selling plan ID

Query parameters

shopify_product_idintegerOptional

Filter by specific Shopify product ID to get all variants for that product

shopify_variant_idintegerOptional

Filter by specific Shopify variant ID to get only that variant (returns single object)

Header parameters

X-Auth-TokenstringRequired

API key for authentication

Responses

200

Product variants with their preorder details and sales metrics

application/json

Responseone of

or

400

Bad request - cannot filter by both product and variant ID

application/json

401

Unauthorized

404

Selling plan not found or variant not found in this selling plan

application/json

get

/preorders/{id}/product_variants

HTTPcURLJavaScriptPython

GET /api/v1/external/preorders/{id}/product_variants HTTP/1.1
Host: app.stoqapp.com
X-Auth-Token: text
Accept: */*

{
  "selling_plan_id": "abc-123-def-456",
  "selling_plan_name": "Summer Preorder",
  "currency": "USD",
  "product_variants": [
    {
      "shopify_product_id": 7891011,
      "shopify_variant_id": 1234567,
      "product_title": "Summer T-Shirt",
      "variant_title": "Large / Blue",
      "preorder_units_sold": 2,
      "preorder_max_count": 10,
      "shipping_text": "Ships in 2-3 weeks"
    }
  ],
  "meta": {
    "total_variants": 1,
    "total_units_sold": 2
  }
}