VTEX · Example Payload

Vtex Specificationsbycategoryid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Specificationsbycategoryid 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": "SpecificationsByCategoryId",
  "method": "GET",
  "path": "/api/catalog_system/pub/specification/field/listByCategoryId/{categoryId}",
  "summary": "VTex Get specifications by category ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "Name": "Specification A",
          "CategoryId": 1,
          "FieldId": 33,
          "IsActive": true,
          "IsStockKeepingUnit": false
        },
        {
          "Name": "Specification B",
          "CategoryId": 1,
          "FieldId": 34,
          "IsActive": true,
          "IsStockKeepingUnit": false
        },
        {
          "Name": "Specification C",
          "CategoryId": 1,
          "FieldId": 35,
          "IsActive": false,
          "IsStockKeepingUnit": false
        }
      ]
    }
  ]
}