Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Update variant groups

Bulk-patches variant groups by id. Successful entities are returned in data; per-item failures in errors.

PATCH/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
Request body
requiredapplication/json
variant_groupsPatchVariantGroupItem[]required
min items 1 · max items 20
Show properties
Array of PatchVariantGroupItem
idUUIDrequired
namestring
slugstring
descriptionstring
priorityinteger
attributesUUID[]
channel_statusesVariantGroupChannelStatusInput[]
Show properties
Array of VariantGroupChannelStatusInput
channel_idUUIDrequired
statusstringrequired
Responses
200

Patched (partial success possible)

dataVariantGroup[]required
Show properties
Array of VariantGroup
idUUIDrequired
namestringrequired
slugstringrequired
descriptionstring
product_idUUIDrequired
priorityinteger
attributesVariantGroupAttribute[] | null
Show properties
Array of VariantGroupAttribute
attribute_idUUIDrequired
attribute_keystring
attribute_namestring
template_keystring
template_namestring
variantsVariantGroupVariant[] | null
Show properties
Array of VariantGroupVariant
idUUIDrequired
variant_namestring
variant_numberstring
statusstring
translationsVariantGroupTranslations | null
Show properties
Any of:
VariantGroupTranslations
nameTranslation[]
Show properties
Array of Translation
idUUID
localestring
valuestring
slugTranslation[]
descriptionTranslation[]
null
null
channel_statusesVariantGroupChannelStatus[] | null
Show properties
Array of VariantGroupChannelStatus
channel_idUUIDrequired
channel_slugstring
statusstringrequired
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
errorsVariantGroupError[]required
Show properties
Array of VariantGroupError
namestring
product_idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
messagestringrequired
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
Bodyapplication/json
Request
curl -X PATCH 'https://api.enad.io/api/v2/string/string/products/variant-groups' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "variant_groups": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "description": "string",
      "priority": 0,
      "attributes": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "channel_statuses": [
        {
          "channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
          "status": "string"
        }
      ]
    }
  ]
}'
Response
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "description": "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"
        }
      ],
      "variants": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "variant_name": "string",
          "variant_number": "string",
          "status": "string"
        }
      ],
      "translations": {
        "name": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "locale": "string",
            "value": "string"
          }
        ],
        "slug": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "locale": "string",
            "value": "string"
          }
        ],
        "description": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "locale": "string",
            "value": "string"
          }
        ]
      },
      "channel_statuses": [
        {
          "channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
          "channel_slug": "string",
          "status": "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"
    }
  ],
  "errors": [
    {
      "name": "string",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "message": "string"
    }
  ]
}