List a customer's addresses

curl --request GET \
  --url https://api.mercemur.com/api/v1/customers/{customerId}/addresses \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mercemur.com/api/v1/customers/{customerId}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/customers/{customerId}/addresses"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/customers/{customerId}/addresses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/customers/{customerId}/addresses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "address_1": "<string>",
      "address_2": null,
      "city": "<string>",
      "company": null,
      "country_code": "<string>",
      "created_at": "<string>",
      "customer_id": "<string>",
      "first_name": "<string>",
      "id": "<string>",
      "is_default_billing": true,
      "is_default_shipping": true,
      "label": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "postal_code": "<string>",
      "province": "<string>",
      "updated_at": "<string>"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

List a customer's addresses

One customer’s saved address book, newest first. THIS IS WHERE AN ADDRESS ID COMES FROM. It is published nowhere else on this API: the customer read carries no addresses, an order’s address is a snapshot with no id, the customers/created webhook withholds them, and the erasure route reports a count. DELETE /api/v1/customers//addresses/ takes an id from this page and nowhere else. A SUB-RESOURCE rather than a field on the customer, deliberately: a page of a hundred customers would otherwise carry every postal address in the store on a read whose caller usually wants names. A CUSTOMER THAT DOES NOT EXIST IS A 404, not an empty page. “This shopper has no addresses” and “this shopper does not exist” lead to opposite next actions, and another store’s customer answers the same 404 so an id cannot be probed. THIS READ IS AUDITED. It is the most sensitive thing read_customers exports, so the trail records that it happened and at what scale, never the addresses.

GET

api

customers

{customerId}

addresses

List a customer's addresses

curl --request GET \
  --url https://api.mercemur.com/api/v1/customers/{customerId}/addresses \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mercemur.com/api/v1/customers/{customerId}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/customers/{customerId}/addresses"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/customers/{customerId}/addresses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/customers/{customerId}/addresses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "address_1": "<string>",
      "address_2": null,
      "city": "<string>",
      "company": null,
      "country_code": "<string>",
      "created_at": "<string>",
      "customer_id": "<string>",
      "first_name": "<string>",
      "id": "<string>",
      "is_default_billing": true,
      "is_default_shipping": true,
      "label": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "postal_code": "<string>",
      "province": "<string>",
      "updated_at": "<string>"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Path Parameters

customerId

string

required

Query Parameters

limit

integer

default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100

after

string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data

object[]

Show child attributes

page

object

Show child attributes

Customers

Customer groups

Segments

Companies

Staff members

Trade credit terms

Trade credit ledger

Wishlist items

Restock alerts

Loyalty

Store credit accounts

Reviews

Review groups

Review queue

Review settings

Review tags

Review question sets

Review request settings

Review assignments

API Reference

List a customer's addresses

Authorizations

Path Parameters

Query Parameters

Response