VTEX · Example Payload

Vtex Getclientaddresses Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getclientaddresses 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": "GetClientAddresses",
  "method": "GET",
  "path": "/api/storage/profile-system/profiles/{profileId}/addresses",
  "summary": "VTex Get client addresses",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "bf82180e-cf9e-4089-9af6-ae1518555992",
          "document": {
            "postalCode": "2****-0**",
            "countryName": "B*****",
            "countryCode": "BR",
            "administrativeAreaLevel1": "RJ",
            "locality": "L*******",
            "localityAreaLevel1": "locality area",
            "route": "51",
            "streetNumber": "999",
            "profileId": "70caf394-8534-447e-a0ca-1803c669c771"
          },
          "meta": {
            "version": "c9c44895-4589-4d0d-a28d-e0e656ca1926",
            "author": "80aa79a3-aa89-4912-a20e-8ef69af19a6c",
            "creationDate": "2022-01-18T18:51:34.1293829+00:00",
            "lastUpdateDate": "2022-01-18T18:51:34.1293829+00:00"
          }
        }
      ]
    }
  ]
}