VTEX · Example Payload
Vtex Getpagesbycontenttype Example

CommerceE-CommerceRetailMarketplacePayments
Vtex Getpagesbycontenttype 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

{
  "operationId": "GetPagesbyContentType",
  "method": "GET",
  "path": "/_v/cms/api/{projectId}/{content-type}",
  "summary": "VTex Get all CMS pages by content type",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "hasNextPage": false,
        "totalItems": 2,
        "data": [
          {
            "id": "d05d3db8-62b2-4f0b-9b70-d6d25ff29b6e",
            "name": "Electronics",
            "type": "plp",
            "status": "published",
            "versionId": "ed51d1cd-e020-4f16-b48b-ca83e720472d",
            "versionStatus": "published",
            "sections": [
              {
                "id": "1632244409269",
                "name": "RichText",
                "data": {
                  "content": "{\"blocks\":[{\"key\":\"dtg7g\",\"text\":\"-\",\"type\":\"unstyled\",\"depth\":0,\"inlineStyleRanges\":[],\"entityRanges\":[],\"data\":{}}],\"entityMap\":{}}"
                }
              },
              {
                "id": "1632244445091",
                "name": "RichText",
                "data": {
                  "content": "{\"blocks\":[{\"key\":\"2qtft\",\"text\":\",\",\"type\":\"unstyled\",\"depth\":0,\"inlineStyleRanges\":[],\"entityRanges\":[],\"data\":{}}],\"entityMap\":{}}"
                }
              }
            ],
            "parameters": {
              "collection": {
                "sort": "\"\"",
                "brandId": "123"
              }
            }
          },
          {
            "id": "4ab6388d-79e6-492f-adda-3e251b85eeb6",
            "name": "Beauty",
            "type": "plp",
            "status": "published",
            "versionId": "95f940d4-584e-4b3d-9872-8c713ba42583",
            "versionStatus": "published",
            "sections": [
              {
                "id": "1643319987751",
                "name": "SearchBanner",
                "data": {
                  "desktop": {
                    "srcSet": "https://storecomponents.vtexassets.com/assets/vtex.file-manager-graphql/images/dda7c17e-5182-4439-b5af-94f651e2d835___1ef09be73ec9e80c719da13432666441.jpeg"
                  },
                  "mobile": {
                    "srcSet": "https://storecomponents.vtexassets.com/assets/vtex.file-manager-graphql/images/ed8ef334-c1e5-4269-8728-34dbffeda424___1ef09be73ec9e80c719da13432666441.jpeg"
                  },
                  "title": "beauty",
                  "description": "beauty products",
                  "alt": "beauty"
                }
              }
            ],
            "parameters": {
              "collection": {
                "sort": "\"\"",
                "seo": {
                  "title": "Page title",
                  "slug": "/beauty",
                  "description": "beauty products"
                },
                "clusterId": "1182"
              }
            }
          }
        ]
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": {
        "code": "NotFound",
        "message": "storeframework.myvtex.com.br not found",
        "source": "Vtex.Kube.Router.WebApi",
        "requestId": "b49522afa7c94b76885450f652be7bfc"
      }
    }
  ]
}