VTEX · Schema

groups

Array of groups attached to the seller. Groups are defined by key-words that group sellers into categories defined by the marketplace when adding a new seller through the [Configure Seller Account](https://developers.vtex.com/vtex-rest-api/reference/sellers#putupsertseller) endpoint. It is possible to filter sellers by group in the Seller Management page in your VTEX Admin. Know more about groups through our [Seller Management](https://help.vtex.com/en/tutorial/gerenciamento-de-sellers-beta--6eEiOISwxuAWJ8w6MtK7iv#groups) documentation.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Group's unique identifier code.
name string Name of the tag chosen to identify the group.
View JSON Schema on GitHub

JSON Schema

vtex-groups-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Groups",
  "title": "groups",
  "description": "Array of groups attached to the seller. Groups are defined by key-words that group sellers into categories defined by the marketplace when adding a new seller through the [Configure Seller Account](https://developers.vtex.com/vtex-rest-api/reference/sellers#putupsertseller) endpoint. It is possible to filter sellers by group in the Seller Management page in your VTEX Admin. Know more about groups through our [Seller Management](https://help.vtex.com/en/tutorial/gerenciamento-de-sellers-beta--6eEiOISwxuAWJ8w6MtK7iv#groups) documentation.",
  "required": [
    "groups"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Group's unique identifier code.",
      "default": "8d845239bf1448dc8bc3ed3121837511"
    },
    "name": {
      "type": "string",
      "description": "Name of the tag chosen to identify the group.",
      "default": "franchise Accounts"
    }
  },
  "example": {
    "groups": [
      {
        "id": "8d845239bf1448dc8bc3ed3121837511",
        "name": "long tail"
      },
      {
        "id": "b9bcd348ab9c4cec8285ff9485c27a72",
        "name": "franchise accounts"
      }
    ]
  }
}