Get Customer Addresses

GET 
/v2/customers/:customerID/addresses

Get Customer Addresses

Request

Path Parameters

customerID stringrequired

The ID of the customer you want to retrieve.

Responses

200

OK

application/json

Schema

Schema

data object[]

Example (from schema)

{
  "data": [
    {
      "type": "address",
      "first_name": "Ron",
      "last_name": "Swanson",
      "name": "Home",
      "phone_number": "(555) 555-1234",
      "instructions": "Leave behind bin",
      "company_name": "Ron Swanson Enterprises",
      "line_1": "1 Sunny Street",
      "line_2": "Unit 101",
      "city": "Sunny Town",
      "county": "Sunnyville",
      "region": "acc-legal-name",
      "postcode": "SU33 1YY",
      "country": "GB",
      "id": "5f8da740-6680-463e-b31c-190b2db4bf9d",
      "meta": {
        "timestamps": {
          "created_at": "2021-02-23T09:40:33.882Z",
          "updated_at": "2021-02-23T09:40:33.882Z"
        }
      },
      "links": {
        "self": "https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses"
      },
      "relationships": {
        "customer": {
          "id": "11afcf9b-971b-4fdb-8e10-f2ecf970718e",
          "type": "customer"
        }
      }
    }
  ]
}

404

Not Found

application/json

Schema

Schema

errors Error[]required
Array [
status string
The HTTP response code of the error.
title string
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

not-found-error

{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "customer not found"
    }
  ]
}

Loading...