list-product-variants

Method: GET
Path: /catalog/products/{product_id}/variants

Tags: Catalog

Summary

Retrieve product variants

Description

Retrieves the variants of an existing product. Returns the corresponding variant list. Product slug is supported in place of product ID in the path.

Storefront SDK Usage

SDK Method: sdk.catalog.listProductVariants()

Example:

// By product ID
const { data, error } = await sdk.catalog.listProductVariants(
  { product_id: "prod_123" }
);

if (error) {
  console.error("Failed to list product variants:", error);
  return;
}

console.log("Variants found:", data.variants?.length || 0);

data.variants?.forEach(variant => {
  console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.pricing?.selling_price}`);
});

// By product slug (also accepted in place of product_id)
const { data: slugData, error: slugError } = await sdk.catalog.listProductVariants(
  { product_id: "detox-candy" }
);

// Override customer group ID for this specific request
const { data: overrideData, error: overrideError } = await sdk.catalog.listProductVariants(
  { product_id: "prod_123" },
  undefined,
  {
    "x-customer-group-id": "wholesale_customers" // Override default SDK config
  }
);

TypeScript Definition

"list-product-variants": {
        parameters: {
            query?: {
                /** @description Determines whether to include or exclude inventory details in response json */
                inventory?: boolean;
            };
            header?: {
                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
            };
            path: {
                /** @description Product ID or product slug. Either is accepted in the path. */
                product_id: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description Success response */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** @example Products retrieved successfully. */
                        message: string;
                        success: boolean;
                        content: {
                            variants: components["schemas"]["Variant"][];
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["parameters"]["CustomerGroupId"]	CustomerGroupId
components["schemas"]["Variant"]	Variant
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• x-customer-group-id (header): This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned.
• inventory (query): Determines whether to include or exclude inventory details in response json
• product_id (path): Product ID or product slug. Either is accepted in the path.

Responses

200

Success response

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Catalog"
  ],
  "operationId": "list-product-variants",
  "summary": "Retrieve product variants",
  "description": "Retrieves the variants of an existing product. Returns the corresponding variant list. Product slug is supported in place of product ID in the path.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-product-variants",
    "description": "API reference for the list-product-variants operation"
  },
  "parameters": [
    {
      "$ref": "#/components/parameters/CustomerGroupId"
    },
    {
      "name": "inventory",
      "in": "query",
      "description": "Determines whether to include or exclude inventory details in response json",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "product_id",
      "in": "path",
      "description": "Product ID or product slug. Either is accepted in the path.",
      "required": true,
      "schema": {
        "type": "string",
        "examples": [
          "01H7YK0C86V9PGT0HXRJVEZXJQ",
          "detox-candy"
        ],
        "minLength": 1
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string",
                "examples": [
                  "Products retrieved successfully."
                ]
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "variants": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Variant"
                    }
                  }
                },
                "required": [
                  "variants"
                ],
                "type": "object"
              }
            }
          }
        }
      },
      "links": {
        "AddVariantToCart": {
          "operationId": "update-cart",
          "requestBody": {
            "product_id": "$request.path.product_id",
            "variant_id": "$response.body#/content/variants/0/id"
          },
          "description": "Add a variant to a cart. Use the parent `product_id` and a variant's `id` as `variant_id`."
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    },
    {
      "X-Api-Key": []
    }
  ],
  "x-speakeasy-group": "catalog",
  "x-speakeasy-ignore": false,
  "x-speakeasy-name-override": "listProductVariants"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions