Skip to main content

Get Variation

Retrieve a single variation by ID.

Endpointโ€‹

GET /v1/products/{id}/variations/{variationId}

Authenticationโ€‹

Requires an API key with the products:read scope.

Parametersโ€‹

ParameterTypeLocationDescription
idintegerpathThe product ID
variationIdintegerpathThe variation ID

Responseโ€‹

Success (200 OK)โ€‹

{
"data": {
"id": 3,
"sku": "BIKE-L-RED",
"display_name": "BIKE-L-RED",
"description": "Riders 5'9\" and up",
"image": null,
"values": [
{
"property_id": 1,
"property_name": "Size",
"value": "Large"
},
{
"property_id": 2,
"property_name": "Color",
"value": "Red"
}
],
"inventory_count": 5
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-02-01T10:00:00+00:00"
}
}

Response Fieldsโ€‹

FieldTypeDescription
idintegerUnique identifier
skustringStock keeping unit
display_namestringHuman-readable label. Falls back to property values (e.g. "Large ยท Red") when SKU is empty, or "Variation" if neither is set. Use this for UI labels rather than reconstructing from sku + values.
descriptionstringShort explainer shown under the variation name when customers choose an option (e.g. a size guide). null when not set.
imagestringImage path (if set)
valuesarrayProperty values for this variation
values[].property_idintegerProperty ID
values[].property_namestringProperty name (e.g., "Size")
values[].valuestringProperty value (e.g., "Large")
inventory_countintegerNumber of inventory items for this variation

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/products/1/variations/3" \
-H "Authorization: Bearer YOUR_API_KEY"

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
403insufficient_scopeAPI key lacks products:read scope
404resource_not_foundProduct or variation not found