Customer Addresses

Customer addresses are association models that link customers to addresses. Creating a customer address means adding an address to a customer's wallet. During checkout, a logged customer can retrieve their saved addresses and use them as the order shipping or billing addresses.

The customer address object

A customer address object is returned as part of the response body of each successful create, list, retrieve or update API call. The following table contains the list of all its fields along with their type, description and example values.
Object fields:
name
string
Returns the associated address' name
Example:
John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228
id
integer
Unique identifier for the resource.
Example:
1234
created_at
datetime
Time at which the resource was created.
Example:
2018-01-01T12:00:00.000Z
updated_at
datetime
Time at which the resource was last updated.
Example:
2018-01-01T12:00:00.000Z
reference
string
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
relationship (N:1)
The associated customer.
relationship (N:1)
The associated address.

Create a customer address

To create a new customer address, send a POST request to the /api/customer_addresses endpoint, passing the resource arguments in the request body. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.
Arguments:
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
#
required
The associated customer.
required
The associated address.
Example request:
POST /api/customer_addresses HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "customer_addresses",
    "relationships": {
      "customer": {
        "data": {
          "type": "customers",
          "id": "1234"
        }
      },
      "address": {
        "data": {
          "type": "addresses",
          "id": "1234"
        }
      }
    }
  }
}
Example response: 201 Created
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "customer_addresses",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234"
    },
    "attributes": {
      "name": "John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "customer": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234/relationships/customer",
          "related": "https://your-brand.commercelayer.io/api/customer_addresses/1234/customer"
        }
      },
      "address": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234/relationships/address",
          "related": "https://your-brand.commercelayer.io/api/customer_addresses/1234/address"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

List all customer addresses

To fetch a collection of customer addresses, send a GET request to the /api/customer_addresses endpoint.

Example request:
GET /api/customer_addresses HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "1234",
      "type": "customer_addresses",
      "links": {
        "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234"
      },
      "attributes": {
        "name": "John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228",
        "id": "1234",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANYREFEFERNCE",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "customer": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234/relationships/customer",
            "related": "https://your-brand.commercelayer.io/api/customer_addresses/1234/customer"
          }
        },
        "address": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234/relationships/address",
            "related": "https://your-brand.commercelayer.io/api/customer_addresses/1234/address"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 24 customer_addresses (first page)"
    }
  ],
  "meta": {
    "record_count": 125,
    "page_count": 5
  },
  "links": {
    "first": "/api/customer_addresses?page[number]=1&page[size]=25",
    "prev": "/api/customer_addresses?page[number]=2&page[size]=25",
    "next": "/api/customer_addresses?page[number]=4&page[size]=25",
    "last": "/api/customer_addresses?page[number]=5&page[size]=25"
  }
}
Available filters
idreferencecustomer_ididscreated_at_fromcreated_at_toupdated_at_fromupdated_at_tocountry_code
Sortable attributes
idcreated_atupdated_atreference

Retrieve a customer address

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.
Example request:
GET /api/customer_addresses/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "customer_addresses",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234"
    },
    "attributes": {
      "name": "John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "customer": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234/relationships/customer",
          "related": "https://your-brand.commercelayer.io/api/customer_addresses/1234/customer"
        }
      },
      "address": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234/relationships/address",
          "related": "https://your-brand.commercelayer.io/api/customer_addresses/1234/address"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Update a customer address

To update an existing customer address, send a PATCH request to the /api/customer_addresses/{{id}} endpoint, where {{id}} is the id of the resource that you want to update. The following table contains the list of all the possible arguments that you can pass with the request body, along with their type, description and examples values. Please note that all arguments are optional.
Arguments:
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
#
optional
The associated customer.
optional
The associated address.
Example request:
PATCH /api/customer_addresses/1234 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "customer_addresses",
    "id": 1234,
    "attributes": {
      "reference": "ANYREFEFERNCE"
    },
    "relationships": {
    }
  }
}
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "customer_addresses",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234"
    },
    "attributes": {
      "name": "John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "customer": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234/relationships/customer",
          "related": "https://your-brand.commercelayer.io/api/customer_addresses/1234/customer"
        }
      },
      "address": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_addresses/1234/relationships/address",
          "related": "https://your-brand.commercelayer.io/api/customer_addresses/1234/address"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Delete a customer address

To delete a customer address, send a DELETE request to the /api/customer_addresses/{{id}} endpoint, where {{id}} is the id of the resource that you want to delete.
Example request:
DELETE /api/customer_addresses/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 204 No Content
HTTP/1.1 204 No Content

Get our machine-readable JSON schema that follows the OpenAPI Specification (formerly Swagger).

Get our Postman collection in one click and start making real calls to Commerce Layer API in minutes.

Get in touch with our support team if you have any questions or want to learn more about Commerce Layer.