VTEX · Example Payload

Vtex Getversion Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getversion 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": "Getversion",
  "method": "GET",
  "path": "/api/dataentities/{dataEntityName}/documents/{id}/versions/{versionId}",
  "summary": "VTex Get version",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "cSIAceEelBEmSOqRkzJYLRQuGgi6.CqF",
        "author": "1f936e42-79b3-4e5b-91d2-da9a8af0b215",
        "document": {
          "id": "cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827",
          "dataEntityId": "Newsletter",
          "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
          "accountName": "apiexamples",
          "followers": [],
          "schemas": [
            "testprofile",
            "testprofile2"
          ],
          "email": "clark.kent@examplemail.com"
        }
      }
    }
  ]
}