VTEX · Example Payload

Vtex Get Productsfromacollection Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Productsfromacollection 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-Productsfromacollection",
  "method": "GET",
  "path": "/api/catalog/pvt/collection/{collectionId}/products",
  "summary": "VTex Get products from a collection",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Page": 1,
        "Size": 2,
        "TotalRows": 2,
        "TotalPage": 1,
        "Data": [
          {
            "ProductId": 1,
            "SkuId": 1,
            "SubCollectionId": 24,
            "Position": 1,
            "ProductName": "Ra\u00e7\u00e3o Royal Canin Feline Urinary",
            "SkuImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155450"
          },
          {
            "ProductId": 2,
            "SkuId": 3,
            "SubCollectionId": 24,
            "Position": 2,
            "ProductName": "Caixa de Areia Azul Petmate",
            "SkuImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451"
          }
        ]
      }
    }
  ]
}