VTEX · Example Payload

Vtex Post Apicatalogpvtcollection Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Post Apicatalogpvtcollection 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-apicatalogpvtcollection",
  "method": "POST",
  "path": "/api/catalog/pvt/collection",
  "summary": "VTex Create collection",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": 150,
        "Name": "Test",
        "Description": "Winter outfits.",
        "Searchable": true,
        "Highlight": false,
        "DateFrom": "2017-09-27T10:47:00",
        "DateTo": "2017-09-27T10:47:00",
        "TotalProducts": 150,
        "Type": "Manual"
      }
    }
  ]
}