VTEX · Example Payload

Vtex Getaddressbypostalcode Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getaddressbypostalcode 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": "GetAddressByPostalCode",
  "method": "GET",
  "path": "/api/checkout/pub/postal-code/{countryCode}/{postalCode}",
  "summary": "VTex Get address by postal code",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "postalCode": "12345000",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BRA",
        "street": "My street",
        "number": "34",
        "neighborhood": "My neighborhood",
        "complement": "Apto 101",
        "reference": "Reference",
        "geoCoordinates": []
      }
    }
  ]
}