Get Address List

GET 
/openapi/2022-01/customers/:customer_id/addresses

Retrieve a list of all address with pagination.

Request

Path Parameters

customer_id stringrequired

Cusomer's ID

Query Parameters

limit int32
Limit per page, maximum: 250
Default value: 10
page int32
Page number
Default value: 1

Responses

200

200

application/json

Schema

Schema

addresses object[]
Array [
idstring
Example: 2490dc6a-d511-4e5e-bbcb-d58e913243ad
customer_idstring
Example: 2dd957e3-2051-4cdf-8584-9c0046b4d1ae
first_namestring
Example: Ryan
last_namestring
Example: zhang
companystring
Example: ABC Limited
citystring
Example: SAN JOSE
provincestring
Example: New Mexico
countrystring
Example: United States
zipstring
Example: 87036
province_codestring
Example: NM
country_codestring
Example: US
genderstring
Example: male
phonestring
Example: +8615015570043
phone_area_codestring
Example: +86
areastring
Example: Bay area
emailstring
Example: [email protected]
namestring
Example: Ryan zhang
address1string
Example: 1 Rue des Carrieres
address2string
Example: Suite 1234
country_namestring
Example: United States
defaultboolean
Default value: true
Example: true
]

Example

{
  "addresses": [
    {
      "id": "2490dc6a-d511-4e5e-bbcb-d58e913243ad",
      "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
      "first_name": "Ryan",
      "last_name": "zhang",
      "company": "ABC Limited",
      "city": "SAN JOSE",
      "province": "New Mexico",
      "country": "United States",
      "zip": "87036",
      "province_code": "NM",
      "country_code": "US",
      "gender": "male",
      "phone": "+8615015570043",
      "phone_area_code": "+86",
      "area": "Bay area",
      "email": "[email protected]",
      "name": "Ryan zhang",
      "address1": "1 Rue des Carrieres",
      "address2": "Suite 1234",
      "country_name": "United States",
      "default": true
    }
  ]
}

Result

{
    "addresses": [
        {
            "id": "2490dc6a-d511-4e5e-bbcb-d58e913243ad",
            "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
            "first_name": "Ryan",
            "last_name": "zhang",
            "company": "ABC Limited",
            "city": "SAN JOSE",
            "province": "New Mexico",
            "country": "United States",
            "zip": "87036",
            "province_code": "NM",
            "country_code": "US",
            "gender": "male",
            "phone": "+8615015570043",
            "phone_area_code": "+86",
            "area": "Bay area",
            "email": "[email protected]",
            "name": "Ryan zhang",
            "address1": "1 Rue des Carrieres",
            "address2": "Suite 1234",
            "country_name": "United States",
            "default": true
        }
    ]
}

400

400

application/json

Schema

Schema

oneOf
• object
• object
errorsstring[]

Example

{
  "errors": [
    ""
  ]
}

Result

{
  "errors": [
    "Exceeds maximum limit of 250"
  ]
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Record not found"
  ]
}

Result

{
  "errors": [
    "Record not found"
  ]
}