VTEX · Example Payload

Vtex Getprofile Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getprofile 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": "GetProfile",
  "method": "GET",
  "path": "/api/storage/profile-system/profiles/{profileId}",
  "summary": "VTex Get profile",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "70caf394-8534-447e-a0ca-1803c669c771",
          "meta": {
            "version": "abc",
            "author": "e40e0b6d-0605-4fa6-8176-1d69fbaf0818",
            "creationDate": "13/12/2021T00:00:00Z",
            "lastUpdate": "13/12/2021T00:00:00Z"
          },
          "document": {
            "firstName": "J***",
            "lastName": "D**",
            "email": "j***.d**@e******.c**",
            "birthDate": "1925-11-17",
            "document": "1**********",
            "documentType": "CPF",
            "{customField}": "{value}"
          }
        }
      ]
    }
  ]
}