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": {
    "id": {
      "op": "IN",
      "value": "61df41892bf06d00092d0d8a"
    },
    "type": {
      "op": "IN",
      "value": "BILLING"
    },
    "addressLine1": {
      "op": "IN",
      "value": "123 Main St."
    },
    "city": {
      "op": "IN",
      "value": "Seattle"
    },
    "region": {
      "op": "IN",
      "value": "WA"
    },
    "postalCode": {
      "op": "IN",
      "value": 98121
    },
    "county": {
      "op": "IN",
      "value": "King County"
    },
    "country": {
      "op": "IN",
      "value": "US"
    },
    "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

match. id · object

A unique identifier of the search criteria.

Show child attributes

match.id. op · enum<string> · required

The type of search operation.

Available options: IN, EQUALS

Example:

"IN"

match.id. value · string · required

A 24-character system-generated ID of the given search criteria.

Example:

"61df41892bf06d00092d0d8a"

match. type · object

The criteria to search based on the type of address.

Show child attributes

match.type. op · enum<string> · required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options: IN, NOT_IN, EQUALS, CONTAINS, NOT_EQUALS

Example:

"IN"

match.type. value · enum<string> · required

The type of address.

Available options: BILLING, SHIPPING

Example:

"BILLING"

match. addressLine1 · object

The criteria to search by the first, second, or third line of the customer's address.

Show child attributes

match.addressLine1. op · enum<string> · required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options: IN, NOT_IN, EQUALS, CONTAINS, NOT_EQUALS

Example:

"IN"

match.addressLine1. value · string · required

The first, second, or third line of the customer's address.

Example:

"123 Main St."

match. city · object

The criteria to search for customer's addresses based on the city given in the address.

Show child attributes

match.city. op · string · required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations. - IN - NOT_IN - EQUALS - CONTAINS - NOT_EQUALS

Example:

"IN"

match.city. value · string · required

The city name.

Example:

"Seattle"

match. region · object

The criteria to search for customer's addresses based on the region given in the address.

Show child attributes

match.region. op · enum<string> · required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options: IN, NOT_IN, EQUALS, CONTAINS, NOT_EQUALS

Example:

"IN"

match.region. value · string · required

The region name.

Example:

"WA"

match. postalCode · object

The criteria to search for customer's addresses based on postalCode given in the address.

Show child attributes

match.postalCode. op · enum<string> · required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options: IN, NOT_IN, EQUALS, CONTAINS, NOT_EQUALS

Example:

"IN"

match.postalCode. value · string · required

The postal or ZIP code of the address.

Example:

98121

match. county · object

The criteria to search for customer's address based on the county given in the address.

Show child attributes

match.county. op · string

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations. - IN - NOT_IN - EQUALS - CONTAINS - NOT_EQUALS

Example:

"IN"

match.county. value · string

The county name.

Example:

"King County"

match. country · object

The criteria to search for the customer's address based on the country given in the address.

Show child attributes

match.country. op · enum<string> · required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options: IN, NOT_IN, EQUALS, CONTAINS, NOT_EQUALS

Example:

"IN"

match.country. value · string · required

The country code, which can be a full name, ISO 3166-1 alpha-2, or an alpha-3 code.

Example:

"US"

match. latitude · object

The criteria to search for customer's address based on latitude or a range of latitudes given in the address.

Show child attributes

match.latitude. op · enum<string> · required

The type of search operation, such as equals, less than (LT), greater than (GT), less than or equal to (LTE), greater than or equal to (GTE), or within a specified range.

Available options: EQUALS, LTE, GTE, GT, LT, RANGE

Example:

"LTE"

match.latitude. value · number<double>

The latitude value in decimal degrees format; negative is degrees West.

Example:

47.6205

match.latitude. startLatitude · number<double>

The starting value of the latitude range. This is used with the endLatitude property. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

Example:

47.6205

match.latitude. endLatitude · number<double>

The ending value of the latitude range. This is used with the startLatitude property. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

Example:

47.6205

Example:

{ "op": "LTE", "value": 47.6205 }

match. longitude · object

The criteria to search for customer's address based on longitude or a range of longitude given in the address.

Show child attributes

match.longitude. op · enum<string> · required

The type of search operation, such as equals, less than (LT), greater than (GT), less than or equal to (LTE), greater than or equal to (GTE), or within a specified range.

Available options: EQUALS, LTE, GTE, GT, LT, RANGE

Example:

"LTE"

match.longitude. value · number<double>

The longitude value in decimal degrees format; negative is degrees West.

Example:

-77.0364

match.longitude. startLongitude · number<double>

The starting value of the longitude range. This is used with the endLongitude property and formatted to decimal degrees; negative is degrees West.

Example:

-77.0364

match.longitude. endLongitude · number<double>

The ending value of the longitude range. This is used with the startLongitude property and formatted to decimal degrees; negative is degrees West.

Example:

-77.0364

Example:

{ "op": "LTE", "value": -77.0364 }

match. createdAt · object

The criteria to search for customers or their addresses based on a specific creation date or within a creation date range.

Show child attributes

match.createdAt. op · enum<string> · required

The type of search operation, such as equals, less than (LT), greater than (GT), less than or equal to (LTE), greater than or equal to (GTE), or within a specified range.

Available options: EQUALS, LTE, GTE, GT, LT, RANGE

Example:

"LTE"

match.createdAt. value · string

The time of creation, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"

match.createdAt. startCreatedAt · string

The starting value of the creation date range. This is used with the endCreatedAt property.

Example:

"2023-08-30T23:20:42.822Z"

match.createdAt. endCreatedAt · string

The ending value of the creation date range. This is used with the startCreatedAt property.

Example:

"2023-08-31T23:20:42.822Z"

Example:

{
  "op": "LTE",
  "value": "2023-08-30T23:20:42.822Z"
}

match. updatedAt · object

The criteria to search for customers or their addresses based on a specific date or date range in which the record was updated.

Show child attributes

match.updatedAt. op · enum<string> · required

The type of search operation, such as equals, less than (LT), greater than (GT), less than or equal to (LTE), greater than or equal to (GTE), or within a specified range.

Available options: EQUALS, LTE, GTE, GT, LT, RANGE

Example:

"LTE"

match.updatedAt. value · string

The time of last update, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"

match.updatedAt. startUpdatedAt · string

The starting value of the updatedAt date range. This is used with the endUpdatedAt property.

Example:

"2023-08-30T23:20:42.822Z"

match.updatedAt. endUpdatedAt · string

The ending value of the updatedAt date range. This is used with the startUpdatedAt property.

Example:

"2023-08-31T23:20:42.822Z"

Example:

{
  "op": "LTE",
  "value": "2023-08-30T23:20:42.822Z"
}

match. deletedAt · object

The criteria to search for customers or their addresses based on a specific deletion date or within a deletion date range.

Show child attributes

match.deletedAt. op · enum<string> · required

The type of search operation, such as equals, less than (LT), greater than (GT), less than or equal to (LTE), greater than or equal to (GTE), or within a specified range.

Available options: EQUALS, LTE, GTE, GT, LT, RANGE

Example:

"LTE"

match.deletedAt. value · string

The time of deletion, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"

match.deletedAt. startDeletedAt · string

The starting value of the deletedAt date range. This is used with the endDeletedAt property.

Example:

"2023-08-30T23:20:42.822Z"

match.deletedAt. endDeletedAt · string

The ending value of the deletedAt date range. This is used with the startDeletedAt property.

Example:

"2023-08-31T23:20:42.822Z"

Example:

{
  "op": "LTE",
  "value": "2023-08-30T23:20:42.822Z"
}

match. additionalAttributes · object

The criteria to search for customers or their addresses based on additional attributes. The criteria to search by a string value.

Option 1

Option 2

Show child attributes

match.additionalAttributes. op · enum<string> · required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options: IN, NOT_IN, EQUALS, CONTAINS, NOT_EQUALS

Example:

"IN"

match.additionalAttributes. key · string · required

The key for the additional attribute. This should be the field name given in the additionalAttributes schema.

Example:

"gps"

match.additionalAttributes. value · string

The value of the string.

Example:

"beach"

match. isDeleted · enum<boolean>

A flag indicating whether the search results should include only deleted addresses. Set to true to include only deleted addresses and false to exclude deleted addresses.

Available options: true, false

Example:

false

match. isDefault · enum<boolean>

A flag indicating whether the search results should include only default addresses. Set to 'true' to include only default addresses and 'false' to exclude default addresses.

Available options: true, false

Example:

true

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

query. offset · number

The number of records to skip before returning records. For example, when offset is 20 and limit's 10, you get records from 21 to 30. When they're not specified, you get up to 10 records.

Example:

0

query. limit · number

The maximum number of records per page.

Example:

20

query. count · number

The total number of records in the response.

Example:

100

data · object[]

addresses of the sent customer

Show child attributes

data. id · string · required

A 24-character system-generated ID of the address.

Example:

"61604a30fdfacd0009816e44"

data. address · object · required

The address details.

Show child attributes

data.address. type · enum<string> · required

The address type.

Available options: BILLING, SHIPPING

Example:

"BILLING"

data.address. addressLine1 · string

The first line of the address.

Example:

"123 Main St."

data.address. addressLine2 · string

The second line of the address.

Example:

"Suite 100"

data.address. addressLine3 · string

The third line of the address.

Example:

"Seventh floor"

data.address. addressLine4 · string

The fourth line of the address.

Example:

"Attention: Pat E. Doe"

data.address. city · string

The city name in the address.

Example:

"Seattle"

data.address. region · string

The region or state name in the address.

Example:

"WA"

data.address. postalCode · string

The postal or ZIP code of the address.

Example:

98121

data.address. county · string

The administrative division or county within a country or state.

Example:

"King County"

data.address. country · string

The country code, which can be a full name, or an ISO 3166-1 alpha-2 or alpha-3 code.

Example:

"US"

data.address. latitude · number<double>

The geographical latitude used with longitude to locate the exact address. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

Example:

47.6205

data.address. longitude · number<double>

The geographical longitude used with latitude to locate the exact address. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

Example:

-122.3493

data. isDeleted · boolean · required

A flag indicating whether the address is deleted. true indicates the address is deleted and false indicates otherwise.

Example:

false

data. createdAt · string<date-time> · required

The time when the address was created, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"

data. updatedAt · string<date-time> | null · required

The time when the address was the last updated, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"

data. additionalAttributes · object

A placeholder for additional info, in key-value pairs.

Example:

{ "landmark": "Beach" }

data. isDefault · boolean

A flag indicating whether the address is the default one.true indicates the given address is the default address and false indicates otherwise.

Example:

false

data. deletedAt · string<date-time> | null

The time when the address was deleted, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"