Getting Started
Authentication v3
- Concepts
- System Apps
- User Apps
- Authentication Endpoints
Product Catalog
- Product Catalog API - Overview
- Developer Guide
- Data Ingestion Best Practices
- Attributes & Attribute Mapping
- Categories
- Products
- Collections
- Background Jobs
- Bulk Import & Export
- Published Products
Orders
- Orders (3.0.0)
- Developer Guide
- Orders FAQ
- Shopping Lists
- Shipping Methods
- Imports
- Exports
- Orders
- Frauds
- Notifications
- Backorders Preorders
- Cancellations
- Allocations
- Shipments
- Inventory Transfers
- Tracking
- Invoices
- Payments
- Credits
- Appeasements
- Returns
Inventory
- Inventory (3.0.0)
- Inventory FAQ
- Imports
- Counters
- Inventory
- Locations
- Networks
Integrations
Offers
- Offers (3.0.0)
- Developer Guide
- Real-time Pricing Engine
- Webhook Events
- Price Lists
- Prices
- Promotions
- Coupons
- Coupon Codes
- Redemptions
- Segments
- Product Exclusion Lists
- Attributes
- Price Types
- Priced Products
- Price Controls
- Imports
- Exports
- Price Methods
- Add-ons
Carts
- Overview
- Developer Guides
- Carts
- Order Draft
- Items
- Addresses
- Payments
- Fulfillment
- Customer
- Coupons
- Validations
- Cart Orchestrator
Customers
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.
The access token.
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.
A UUID of the request.
A 24-character system-generated ID of the customer. This is returned in the response of the POST /customers endpoint.
The criteria to search for customer's addresses.
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.
match
A unique identifier of the search criteria.
The type of search operation.
A 24-character system-generated ID of the given search criteria.
The criteria to search based on the type of address.
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.
The type of address.
The criteria to search by the first, second, or third line of the customer's address.
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.
The first, second, or third line of the customer's address.
The criteria to search for customer's addresses based on the city given in the address.
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
The city name.
The criteria to search for customer's addresses based on the region given in the address.
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.
The region name.
The criteria to search for customer's addresses based on postalCode given in the address.
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.
The postal or ZIP code of the address.
The criteria to search for customer's address based on the county given in the address.
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
The county name.
The criteria to search for the customer's address based on the country given in the address.
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.
The country code, which can be a full name, ISO 3166-1 alpha-2, or an alpha-3 code.
The criteria to search for customer's address based on latitude or a range of latitudes given in the address.
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.
The latitude value in decimal degrees format; negative is degrees West.
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.
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.
The criteria to search for customer's address based on longitude or a range of longitude given in the address.
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.
The longitude value in decimal degrees format; negative is degrees West.
The starting value of the longitude range. This is used with the endLongitude property and formatted to decimal degrees; negative is degrees West.
The ending value of the longitude range. This is used with the startLongitude property and formatted to decimal degrees; negative is degrees West.
The criteria to search for customers or their addresses based on a specific creation date or within a creation date range.
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.
The time of creation, in UTC format.
The starting value of the creation date range. This is used with the endCreatedAt property.
The ending value of the creation date range. This is used with the startCreatedAt property.
The criteria to search for customers or their addresses based on a specific date or date range in which the record was updated.
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.
The time of last update, in UTC format.
The starting value of the updatedAt date range. This is used with the endUpdatedAt property.
The ending value of the updatedAt date range. This is used with the startUpdatedAt property.
The criteria to search for customers or their addresses based on a specific deletion date or within a deletion date range.
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.
The time of deletion, in UTC format.
The starting value of the deletedAt date range. This is used with the endDeletedAt property.
The ending value of the deletedAt date range. This is used with the startDeletedAt property.
The criteria to search for customers or their addresses based on additional attributes.
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.
The value of the string.
The key for the additional attribute. This should be the field name given in the additionalAttributes schema.
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.
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.
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.
The maximum number of records in a single page.
{
"query": {
"offset": 0,
"limit": 20,
"count": 100
},
"data": [
{
"id": "61604a30fdfacd0009816e44",
"address": {
"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",
"type": "BILLING",
"latitude": 47.6205,
"longitude": -122.3493
},
"additionalAttributes": {
"landmark": "Beach"
},
"isDeleted": false,
"isDefault": false,
"deletedAt": "2023-08-30T23:20:42.822Z",
"createdAt": "2023-08-30T23:20:42.822Z",
"updatedAt": "2023-08-30T23:20:42.822Z"
}
]
}Authorizations
The access token.
Headers
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.
A UUID of the request.
Path Parameters
A 24-character system-generated ID of the customer. This is returned in the response of the POST /customers endpoint.
Body
The criteria to search for customer's addresses.
match
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.
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.
The maximum number of records in a single page.
Response
The list of customer addresses for the customerId.
The pagination criteria.
addresses of the sent customer
Was this page helpful?
{
"query": {
"offset": 0,
"limit": 20,
"count": 100
},
"data": [
{
"id": "61604a30fdfacd0009816e44",
"address": {
"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",
"type": "BILLING",
"latitude": 47.6205,
"longitude": -122.3493
},
"additionalAttributes": {
"landmark": "Beach"
},
"isDeleted": false,
"isDefault": false,
"deletedAt": "2023-08-30T23:20:42.822Z",
"createdAt": "2023-08-30T23:20:42.822Z",
"updatedAt": "2023-08-30T23:20:42.822Z"
}
]
}