API reference · Customers · Addresses

List Customer Addresses

Method: GET
Route: /customer/addresses/:document
Base URL: https://ws.autorei.net
Path parameters: :document
Token: Requires Bearer token

Opens this request in the public API documentation, the official source of the reference.

Description

Lists the addresses of a customer in your store.

Path parameters

Parameter	Type	Required	Description
`document`	string	Yes	Customer's CPF or CNPJ.

Response · 200

Array with one object per address. Comes as [] when the customer has no address.

Field	Type	Description
`id`	integer	Address id. It is what removal asks for.
`name`	string	Address name.
`zipcode`	string	CEP, formatted (`04543-000`).
`street` · `number` · `complement`	string	Street, number and complement.
`quarter` · `city` · `state`	string	Neighborhood, city and state (UF).
`principal`	boolean	Whether it is the customer's main address.
`addressType`	string	`RESIDENTIAL` or `BUSINESS`.
`farmerStateRegistration`	string	Rural producer state registration. `null` when there is none.
`howToReachLocationDescription`	string	Instructions for reaching the location. `null` when there are none.
`responsibleContact`	string	Contact person at the address. `null` when there is none.
`attributes`	object	Custom address attributes. Comes as `{}` when there are none.
`dateCreated` · `lastUpdated`	string	Creation and last change, in UTC.

Errors

Code	When
404	Document not registered in your store.
401	Token missing, malformed or expired.

Example request

curl --request GET 'https://ws.autorei.net/customer/addresses/:document' \
  --header 'Authorization: Bearer {{access_token}}'

Example responses

200Success — one address

[
  {
    "id": 4470701,
    "name": "Endereço de cadastro",
    "zipcode": "01310-100",
    "street": "Avenida Paulista",
    "number": "1578",
    "complement": "Conjunto 42",
    "quarter": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "principal": true,
    "addressType": "RESIDENTIAL",
    "farmerStateRegistration": null,
    "howToReachLocationDescription": null,
    "responsibleContact": null,
    "attributes": {},
    "dateCreated": "2026-09-01T13:42:07Z",
    "lastUpdated": "2026-09-01T13:42:07Z"
  }
]

Used in

Use casesB2B procurement and supplies: the typical path through the API

POST Add Address to Customer /customer/:document/address
DELETE Remove Customer Address /customer/:document/address/:addressId
DELETE Remove All Customer Addresses /deleteAllCustomerAddress/:document

← See the group: Customers

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.