Get Address Details

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

Retrieve details of a specific address using its unique identifier.

Request

Path Parameters

customer_id stringrequired

Customer's ID

address_id stringrequired

Address's ID

Responses

200

200

application/json

Schema

Schema

address object
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

{
  "address": {
    "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

{
    "address": {
        "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

errorsstring[]

Example

{
  "errors": [
    ""
  ]
}

Result

{
  "errors": [
    ""
  ]
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

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

Result

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