VTEX · Example Payload

Vtex Getclientprofilebyemail Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getclientprofilebyemail 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": "GetClientProfileByEmail",
  "method": "GET",
  "path": "/api/checkout/pub/profiles",
  "summary": "VTex Get client profile by email",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
        "profileProvider": "VTEX",
        "availableAccounts": [],
        "availableAddresses": [
          {
            "addressType": "residential",
            "receiverName": "Clark Kent",
            "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
            "isDisposable": false,
            "postalCode": "12345-000",
            "city": "Metropolis",
            "state": "NY",
            "country": "USA",
            "street": "My street",
            "number": "123",
            "neighborhood": "My neighborhood",
            "complement": "Complement",
            "reference": "Reference",
            "geoCoordinates": [
              -47.924747467041016,
              -15.832582473754883
            ]
          }
        ],
        "userProfile": {
          "email": "clark.kent@example.com",
          "firstName": "Clark",
          "lastName": "Kent",
          "document": "12345678900",
          "documentType": "cpf",
          "phone": "+556199999999",
          "corporateName": "company-name",
          "tradeName": "trade-name",
          "corporateDocument": "12345678000100",
          "stateInscription": "12345678",
          "corporatePhone": "551100988887777",
          "isCorporate": false,
          "profileCompleteOnLoading": false,
          "profileErrorOnLoading": false,
          "customerClass": null
        },
        "isComplete": true
      }
    }
  ]
}