VTEX · Example Payload

Vtex Getbyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getbyid 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": "Getbyid",
  "method": "GET",
  "path": "/api/catalog-seller-portal/category-tree/categories/{categoryId}",
  "summary": "VTex Get Category by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "value": {
          "id": "1",
          "name": "sandboxintegracao",
          "isActive": false
        },
        "children": [
          {
            "value": {
              "id": "2",
              "name": "Perfumes",
              "isActive": false
            }
          }
        ]
      }
    }
  ]
}