POST
/
locations
/
search
curl --request POST \
  --url https://api.fabric.inc/v3/locations/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "filters": [
    {
      "condition": "EQ",
      "field": "location.locationNum",
      "value": "11245"
    },
    {
      "condition": "IN",
      "field": "location.type",
      "values": [
        "DC",
        "STORE"
      ]
    }
  ],
  "sort": "-location.createdAt"
}'
{
  "data": [
    {
      "address": {
        "addressLine1": "123 Main St.",
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Kake",
        "city": "Seattle",
        "contacts": [
          {
            "email": "abc@mail.com",
            "name": {
              "firstName": "Pat",
              "lastName": "Kake",
              "middleName": "E"
            },
            "phone": [
              {
                "number": "0281923712",
                "type": "MOBILE"
              }
            ],
            "type": "OFFICE"
          }
        ],
        "countryCode": "US",
        "postalCode": "98121",
        "region": "WA",
        "type": "Home"
      },
      "capacity": {
        "allocationPercentage": 20,
        "currentAllocations": 5,
        "infiniteAllocation": true,
        "isCapacityFull": true,
        "maxAllocations": 30
      },
      "coordinates": {
        "coordinates": [
          -122.3493,
          47.6205
        ],
        "type": "Point"
      },
      "createdAt": "2022-05-25T07:58:30.996Z",
      "isActive": true,
      "locationId": "9372919a8219e8",
      "locationNumber": 23,
      "name": "Seattle Store",
      "operatingHours": [
        {
          "day": "SUNDAY",
          "hours": [
            {
              "close": "20",
              "open": "10",
              "type": "PICK_UP"
            }
          ]
        }
      ],
      "transfer": {
        "autoStockWindow": "PT10M",
        "isAutoReceiving": true
      },
      "type": "DC",
      "updatedAt": "2022-05-25T07:58:30.996Z"
    }
  ],
  "pagination": {
    "count": 1000,
    "limit": 10,
    "offset": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-fabric-tenant-id
string
required

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.

​
x-fabric-request-id
string

Unique request ID

​
x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is an optional field. The default US channel is 12 while the default Canada channel is 13.

Query Parameters

​
offset
number
default:
0

Number of records to skip before returning all records. Default is 0 when no value is specified.

​
limit
number
default:
10

Maximum number of records per page

Body

application/json

Sample request to search locations

​
filters
object[]
required
​
sort
string
default:
-location.createdAt

Property by which data is sorted. <p> Note: - refers to descending and + refers to ascending order.

Response

200
application/json
OK

Location search response

​
data
object[]
​
pagination
object

An object containing the pagination response data.

Was this page helpful?

Get a specific locationCreate Outage