Skip to content
docs
Guides
ES
CatalogProducts
catalog:read

Get product size guide

Returns the size guide that applies to a product, whether attached directly or inherited from an assignment.

GET/v1/catalog/products/{productId}/size-guide

Returns the size guide that applies to a product, whether attached directly or inherited from an assignment.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Path Parameters

productId*string

Identifier of the product.

Query Parameters

gender?string

Gender the item is intended for.

Value in

  • "unisex"
  • "men"
  • "women"
  • "kids"
  • "baby"
measurementType?string

Measurement type.

Value in

  • "body"
  • "garment"
  • "foot"
  • "accessory"

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/products/7204558912004325301/size-guide" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "id": "7204558912004325301",  "name": "Example resource",  "slug": "example-resource",  "description": "Example description.",  "imageUrl": "https://example.com/resource",  "gender": "unisex",  "measurementType": "body",  "unit": "cm",  "notes": "Example note.",  "rows": [    {      "label": "example",      "sizeKey": "example",      "order": 1,      "measurements": [        {          "key": "example",          "name": "Example resource",          "min": 1,          "max": 1,          "value": 1,          "description": "Example description."        }      ]    }  ]}