VTEX · Example Payload

Vtex Get Collectionsbyseachterms Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Collectionsbyseachterms 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": "GET-Collectionsbyseachterms",
  "method": "GET",
  "path": "/api/catalog_system/pvt/collection/search/{searchTerms}",
  "summary": "VTex Get Collections by search terms",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "paging": {
          "page": 1,
          "perPage": 20,
          "total": 2,
          "pages": 1,
          "limit": 3000
        },
        "items": [
          {
            "id": 158,
            "name": "Cole\u00e7\u00e3o halloween",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2021-10-22T17:56:00",
            "dateTo": "2070-10-22T17:56:00",
            "totalSku": 2,
            "totalProducts": 2,
            "type": "Manual",
            "lastModifiedBy": null
          },
          {
            "id": 160,
            "name": "Halloween costumes",
            "searchable": true,
            "highlight": false,
            "dateFrom": "2020-11-26T15:23:00",
            "dateTo": "2069-11-26T15:23:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
          }
        ]
      }
    }
  ]
}