VTEX · Example Payload

Vtex Post Createcollection Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Post Createcollection 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": "POST-CreateCollection",
  "method": "POST",
  "path": "/api/catalog/pvt/collection/",
  "summary": "VTex Create Collection",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": 160,
        "Name": "Halloween costumes",
        "Description": "HomeHalloween",
        "Searchable": true,
        "Highlight": false,
        "DateFrom": "2020-11-26T15:23:00",
        "DateTo": "2069-11-26T15:23:00",
        "TotalProducts": 0,
        "Type": "Manual"
      }
    }
  ]
}