Comment on page
Retrieve a customer address
How to fetch a specific customer address via API
To fetch a single customer address, send a
GET request to the /api/customer_addresses/:id endpoint, where id is the ID of the resource that you want to retrieve.GET https://yourdomain.commercelayer.io/api/customer_addresses/:id
Request
Response
The following request fetches the customer address identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a
200 OK status code, returning a single resource object:{
"data": {
"id": "xYZkjABcde",
"type": "customer_addresses",
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde"
},
"attributes": {
"name": "John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228",
"customer_email": "[email protected]",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"customer": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde/relationships/customer",
"related": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde/customer"
}
},
"address": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde/relationships/address",
"related": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde/address"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde/events"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/customer_addresses/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 3mo ago