Get addresses list
Get or search in the list of addresses
GET
/v1/addresses/authorization<token>
Use device JWT token
In: header
Query Parameters
searchText?string
customerId?string
Format
uuidindex?integer
Index of the page query parameter
Default
0Range
0 <= valuesize?integer
Number of record on a page query parameter (capped to 100)
Default
10Range
1 <= value <= 100since?string
Start date for date range (first day included). Accepts a date in the format ISO 8601 : YYYY-MM-DD
until?string
End date for date range (last day included). Accepts a date in the format ISO 8601 : YYYY-MM-DD
Response Body
application/json
application/json
application/json
curl -X GET "http://localhost:4012/v1/addresses/"{
"data": [
{
"id": "4f541825-1f1b-4678-b303-adc390dd3469",
"address1": "23 Rue de la Paix",
"city": "Paris",
"country": "France",
"zipCode": "75001",
"isPrimary": true,
"type": "billing",
"createdAt": "2025-05-20T20:08:46.594Z",
"updatedAt": "2025-05-20T20:08:46.594Z",
"regionCode": "IDF",
"customerId": "abcdef01-2345-6789-abcd-ef0123456789"
},
{
"id": "79287b51-da27-4f61-9081-bc1b1d544f0b",
"address1": "Via Condotti 56",
"city": "Rome",
"country": "Italy",
"zipCode": "00187",
"isPrimary": false,
"type": "shipping",
"createdAt": "2025-05-20T20:09:00.932Z",
"updatedAt": "2025-05-20T20:09:00.932Z",
"regionCode": "RM",
"customerId": "ab1cdef01-2345-6789-abcd-ef0123456789"
},
{
"id": "944198e9-5531-4d41-894d-74504a77dc48",
"address1": "Friedrichstraße 123",
"city": "Berlin",
"country": "Germany",
"zipCode": "10719",
"isPrimary": false,
"type": "shipping",
"createdAt": "2025-05-20T20:08:53.195Z",
"updatedAt": "2025-05-20T20:08:53.195Z",
"address2": "Etage 2",
"regionCode": "BE",
"customerId": "bcdef01-2345-6789-abcd-ef0123456789"
}
],
"meta": {
"totalPage": 434,
"totalCount": 1300,
"currentPageIndex": 0,
"pageSize": 3
},
"links": {
"self": "http://localhost/v1/addresses?size=5",
"first": "http://localhost/v1/addresses?size=5&index=0",
"last": "http://localhost/v1/addresses?size=5&index=598",
"next": "http://localhost/v1/addresses?size=5&index=1",
"prev": null
}
}{
"message": "string",
"code": "INSUFFICIENT_BALANCE",
"meta": {
"property1": null,
"property2": null
}
}{
"message": "string",
"code": "INSUFFICIENT_BALANCE",
"meta": {
"property1": null,
"property2": null
}
}