VTEX · Example Payload

Vtex Getcategorytree Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getcategorytree Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "GetCategoryTree",
  "method": "GET",
  "path": "/api/catalog-seller-portal/category-tree",
  "summary": "VTex Get Category Tree",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "roots": [
          {
            "value": {
              "id": "2",
              "name": "Departamento Artesanato",
              "isActive": true
            },
            "children": [
              {
                "value": {
                  "id": "3",
                  "name": "Artesanato de Barro",
                  "isActive": false
                },
                "children": [
                  {
                    "value": {
                      "id": "4",
                      "name": "Artesanato de Barro Vermelho",
                      "isActive": false
                    },
                    "children": []
                  }
                ]
              }
            ]
          },
          {
            "value": {
              "id": "5",
              "name": "Perfumes",
              "isActive": false
            },
            "children": [
              {
                "value": {
                  "id": "6",
                  "name": "Perfume Feminino",
                  "isActive": false
                },
                "children": []
              },
              {
                "value": {
                  "id": "7",
                  "name": "Perfume Masculino",
                  "isActive": false,
                  "displayOnMenu": false,
                  "score": 0,
                  "filterByBrand": false,
                  "isClickable": false
                },
                "children": []
              }
            ]
          }
        ],
        "createdAt": "2021-08-16T20:57:13.070813Z",
        "updatedAt": "2022-07-07T14:24:56.416337Z"
      }
    }
  ]
}