Get product with variants

Retrieve a product and its variants with pagination support.

GET /api/v1/products/{productId}

Headers:
  Authorization: Bearer <api-key>
  Content-Type: application/json

Path parameters

ParameterTypeDescription
productIdstringRequired - The Shopify product REST ID

Query parameters

ParameterTypeDescription
limitintegerOptional - Number of variants per page. Must be between 1 and 100. Default: 50
cursorstringOptional - Pagination cursor from a previous response to fetch the next or previous page

Response example (200 success)

{
  "success": true,
  "data": {
    "product": {
      "id": "123",
      "measurementType": "weight",
      "variants": [
        {
          "id": "456",
          "unitMeasurement": {
            "unit": "kg",
            "value": 1
          },
          "settings": {
            "onlineStore": {
              "displayStyle": "number",
              "rules": {
                "min": 0.5,
                "increment": 0.5,
                "defaultValue": 1,
                "max": null
              }
            }
          }
        }
      ]
    }
  },
  "meta": {
    "nextCursor": "eyJ...",
    "prevCursor": null,
    "hasMore": true
  }
}

Response fields

FieldTypeDescription
successbooleanIndicates whether the request was successful
dataobjectResponse data object
data.productProductThe product object with nested variants
metaPaginationMetaPagination metadata for cursor-based navigation

Error responses

Status codeDescription
400Bad Request - Invalid product ID or invalid limit parameter
401Unauthorized - Missing or invalid API key
404Not Found - Product not found
500Internal Server Error - Server error while processing the request

Note

  • Responses are cached for 5 minutes server-side
  • Products with zero variants will return an empty array with proper pagination metadata
  • Use meta.nextCursor to fetch the next page, or meta.prevCursor for the previous page
  • The limit parameter controls how many variants are returned per page (1-100)

Related:

See the Variant object and PaginationMeta documentation for response structure details.