Search for customer's addresses

With this endpoint, you can search for customer’s addresses based on the specified filter conditions. In addition, you can tailor the search results by including or excluding the deleted addresses and the default addresses.
Note:A customer can have a default address for both billing and shipping.

POST /customers/{customerId}/customer-address/search

Search for customer's addresses

cURL

curl --request POST \
  --url https://api.fabric.inc/v3/customers/{customerId}/customer-address/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "match": {
    "county": {
      "op": "IN",
      "value": "King County"
    },
    "latitude": {
      "op": "LTE",
      "value": 47.6205
    },
    "longitude": {
      "op": "LTE",
      "value": -77.0364
    },
    "createdAt": {
      "op": "LTE",
      "value": "2023-08-30T23:20:42.822Z"
    },
    "updatedAt": {
      "op": "LTE",
      "value": "2023-08-30T23:20:42.822Z"
    },
    "deletedAt": {
      "op": "LTE",
      "value": "2023-08-30T23:20:42.822Z"
    },
    "additionalAttributes": {
      "op": "IN",
      "key": "gps",
      "value": "beach"
    },
    "isDeleted": false,
    "isDefault": true
  },
  "sort": "-createdAt",
  "offset": 0,
  "limit": 10
}
'

200

Example

{
  "query": {
    "offset": 0,
    "limit": 20,
    "count": 100
  },
  "data": [
    {
      "id": "61604a30fdfacd0009816e44",
      "address": {
        "type": "BILLING",
        "addressLine1": "123 Main St.",
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Doe",
        "city": "Seattle",
        "region": "WA",
        "postalCode": 98121,
        "county": "King County",
        "country": "US",
        "latitude": 47.6205,
        "longitude": -122.3493
      },
      "isDeleted": false,
      "createdAt": "2023-08-30T23:20:42.822Z",
      "updatedAt": "2023-08-30T23:20:42.822Z",
      "additionalAttributes": {
        "landmark": "Beach"
      },
      "isDefault": false,
      "deletedAt": "2023-08-30T23:20:42.822Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token.

Headers

x-fabric-tenant-id · string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Example:

"517fa9dfd42d8b00g1o3k312"

x-fabric-request-id · string

A UUID of the request.

Path Parameters

customerId · string · required

A 24-character system-generated ID of the customer. This is returned in the response of the POST /customers endpoint.

Example:

"61a558b1b155125f02be7fb1"

Body

application/json

A sample request to search for the customer's addresses.

The criteria to search for customer's addresses.

match · object · required

match

Show child attributes

sort · string

The criteria to sort results, where - indicates a descending order and + indicates an ascending order. You can sort the following fields - createdAt, updatedAt, type, and country.

Example:

"-createdAt"

offset · number · default: 0

The number of records to skip before returning records. For example, when offset is 20 and limit's 10, this endpoint returns records from 21 to 30.

Example:

0

limit · number · default: 20

The maximum number of records in a single page.

Example:

10

Response

200

application/json

OK

The list of customer addresses for the customerId.

query · object

The pagination criteria.

Show child attributes

data · object[]

addresses of the sent customer

Show child attributes