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-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "sort": "-location.createdAt",
  "filters": [
    {
      "field": "location.locationNum",
      "value": "11245",
      "condition": "EQ"
    },
    {
      "field": "location.type",
      "values": [
        "DC",
        "STORE"
      ],
      "condition": "IN"
    }
  ]
}'
{
  "pagination": {
    "limit": 10,
    "offset": 1,
    "count": 1000
  },
  "data": [
    {
      "locationId": "9372919a8219e8",
      "locationNumber": 23,
      "name": "Seattle Store",
      "isActive": true,
      "address": {
        "addressLine1": "123 Main St.",
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Kake",
        "city": "Seattle",
        "region": "WA",
        "postalCode": "98121",
        "countryCode": "US",
        "type": "Home",
        "contacts": [
          {
            "type": "OFFICE",
            "email": "abc@mail.com",
            "phone": [
              {
                "number": "0281923712",
                "type": "MOBILE"
              }
            ],
            "name": {
              "firstName": "Pat",
              "middleName": "E",
              "lastName": "Kake"
            }
          }
        ]
      },
      "type": "DC",
      "createdAt": "2022-05-25T07:58:30.996Z",
      "updatedAt": "2022-05-25T07:58:30.996Z",
      "operatingHours": [
        {
          "day": "SUNDAY",
          "hours": [
            {
              "open": "10",
              "close": "20",
              "type": "PICK_UP"
            }
          ]
        }
      ],
      "coordinates": {
        "type": "Point",
        "coordinates": [
          -122.3493,
          47.6205
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

Merchant's 24-character tenant ID

x-fabric-channel-id
string
required

Sales channel ID

x-fabric-request-id
string

Unique request ID

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
sort
string
default: -location.createdAt

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

filters
object[]
required

Response

200 - application/json
pagination
object

Pagination response

data
object[]

Was this page helpful?

Get a specific locationInventory FAQ(s)