Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List variant groups

Lists variant groups with their attributes, images, tags and videos. Filter by one or more product ids with the repeatable product-id query parameter.

GET/api/v2/{team_slug}/{app_slug}/products/variant-groups
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
team_slugstringrequired
app_slugstringrequired
Query parameters
pageinteger
per-pageinteger
searchstring
product-idstring<uuid>[]

Repeatable product id filter

Responses
200

OK

dataVariantGroupListItem[]required
Show properties
Array of VariantGroupListItem
idUUIDrequired
namestringrequired
slugstringrequired
product_idUUIDrequired
priorityinteger
attributesVariantGroupAttribute[] | null
Show properties
Array of VariantGroupAttribute
attribute_idUUIDrequired
attribute_keystring
attribute_namestring
template_keystring
template_namestring
imagesProductImageRef[] | null
Show properties
Array of ProductImageRef
idUUIDrequired
urlstring
titlestring
priorityinteger
tagsProductTagRef[] | null
Show properties
Array of ProductTagRef
idUUIDrequired
keystring
namestring
videosProductVideoRef[] | null
Show properties
Array of ProductVideoRef
idUUIDrequired
urlstring
titlestring
created_atstring<date-time>required
updated_atstring<date-time> | null
total_pagesintegerrequired
total_itemsintegerrequired
400

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
401

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
403

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
500

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.enad.io/api/v2/string/string/products/variant-groups' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "priority": 0,
      "attributes": [
        {
          "attribute_id": "ef88e6be-6132-42c9-abcd-a9aadce04df6",
          "attribute_key": "string",
          "attribute_name": "string",
          "template_key": "string",
          "template_name": "string"
        }
      ],
      "images": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "url": "string",
          "title": "string",
          "priority": 0
        }
      ],
      "tags": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "key": "string",
          "name": "string"
        }
      ],
      "videos": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "url": "string",
          "title": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total_pages": 0,
  "total_items": 0
}