Content | Umbraco Commerce

Gets a multi-variants content

get

By default the variants property editor from Umbraco Commerce will only return attribute information with a product node to save on excessive payload sizes. The variants endpoint can be called to dynamically fetch an attibute combinations content only when it is requested.

Path parameters

idstring · uuidRequired

The ID of the content item that has an Umbraco Commerce variants property editor defined on it

Example: fd77b9ea-5b7b-4b94-aab8-3fcdad7efada

Query parameters

attributestring[]Required

The attribute combination of the variant to return

Example: ["key1:value1","key2:value2"]

expandstringOptional

Defines the properties that should be expanded in the response. Refer to the documentation for more details on this.

Example: {"value":""}

Header parameters

Accept-LanguagestringOptional

Defines the language to return. Use this when querying language variant content items.

Example: {"value":""}

Api-KeystringOptional

API key specified through configuration to authorize access to the API.

PreviewbooleanOptional

Whether to request draft content.

Start-ItemstringOptional

URL segment or GUID of a root content item.

Responses

200

application/json

Responseone of

400

Bad Request

404

Not Found

get

GET /umbraco/delivery/api/v1/content/item/{id}/variant?attribute=text HTTP/1.1
Host: 
Accept: */*

{
  "content": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "contentType": "text",
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "name": "text",
    "createDate": "2025-06-22T21:28:23.985Z",
    "updateDate": "2025-06-22T21:28:23.985Z",
    "route": {
      "path": "text",
      "startItem": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "path": "text"
      }
    }
  },
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "isDefault": true
}