Get locations by query

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 '
{
  "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": [
    {
      "locationNumber": 23,
      "name": "Seattle Store",
      "locationId": "9372919a8219e8",
      "isActive": true,
      "address": {
        "region": "WA",
        "addressLine1": 123,
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Kake",
        "city": "Seattle",
        "countryCode": "US",
        "postalCode": 98121,
        "type": "Home",
        "contacts": [
          {
            "type": "OFFICE",
            "email": "[email protected]",
            "phone": [
              {
                "number": "0281923712",
                "type": "MOBILE"
              }
            ],
            "name": {
              "firstName": "Pat",
              "middleName": "E",
              "lastName": "Kake"
            }
          }
        ]
      },
      "type": "DC",
      "capacity": {
        "maxAllocations": 30,
        "currentAllocations": 5,
        "infiniteAllocation": true,
        "allocationPercentage": 20,
        "isCapacityFull": true
      },
      "services": {
        "brand": "WHBM",
        "channel": "Frontline"
      },
      "zones": [
        "<string>"
      ],
      "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
        ]
      },
      "attributes": {
        "isReturns": "true"
      },
      "supportedCarriers": [
        {
          "carrier": "FedEx",
          "serviceLevels": [
            {
              "name": "FedEx",
              "shippingMethod": "FedEx"
            }
          ]
        }
      ],
      "activeFulfillmentMethods": {
        "ShipToHome": "true"
      },
      "transfer": {
        "isAutoReceiving": true,
        "autoStockWindow": "PT10M"
      }
    }
  ],
  "stats": [
    "<string>"
  ]
}

POST

locations

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 '
{
  "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": [
    {
      "locationNumber": 23,
      "name": "Seattle Store",
      "locationId": "9372919a8219e8",
      "isActive": true,
      "address": {
        "region": "WA",
        "addressLine1": 123,
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Kake",
        "city": "Seattle",
        "countryCode": "US",
        "postalCode": 98121,
        "type": "Home",
        "contacts": [
          {
            "type": "OFFICE",
            "email": "[email protected]",
            "phone": [
              {
                "number": "0281923712",
                "type": "MOBILE"
              }
            ],
            "name": {
              "firstName": "Pat",
              "middleName": "E",
              "lastName": "Kake"
            }
          }
        ]
      },
      "type": "DC",
      "capacity": {
        "maxAllocations": 30,
        "currentAllocations": 5,
        "infiniteAllocation": true,
        "allocationPercentage": 20,
        "isCapacityFull": true
      },
      "services": {
        "brand": "WHBM",
        "channel": "Frontline"
      },
      "zones": [
        "<string>"
      ],
      "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
        ]
      },
      "attributes": {
        "isReturns": "true"
      },
      "supportedCarriers": [
        {
          "carrier": "FedEx",
          "serviceLevels": [
            {
              "name": "FedEx",
              "shippingMethod": "FedEx"
            }
          ]
        }
      ],
      "activeFulfillmentMethods": {
        "ShipToHome": "true"
      },
      "transfer": {
        "isAutoReceiving": true,
        "autoStockWindow": "PT10M"
      }
    }
  ],
  "stats": [
    "<string>"
  ]
}

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.

Example:

1

limit

number

default:10

Maximum number of records per page

Example:

10

Body

application/json

Sample request to search locations

filters

object[]

required

Maximum array length: 50

Show child attributes

filters.field

string

required

Field name

Example:

"location.locationNum"

filters.condition

enum<string>

default:EQ

required

Filter conditions.
EQ (Equal to): Searches for exact match.
NEQ (Not equal to): Searches by excluding the specified value.
IN: Search for multiple values.
NIN (Not IN): Excludes the specified values in the search. LT (Less than): Searches for values that are less than the specified value. GT (Greater than): Search for values that are greater than the specified value. LTE (Less than or equal to): Searches for values that are less than or equal to the specified value. GTE (Greater than or equal to): Searches for values that are greater than or equal to the specified value.

Available options:

EQ,

NEQ,

IN,

NIN,

LT,

GT,

LTE,

GTE

Example:

"EQ"

filters.group

string

default:Default

Group name

Example:

"GroupA"

sort

string

default:-location.createdAt

Property by which data is sorted.

Note: - refers to descending and + refers to ascending order.

Example:

"+location.createdAt"

Response

Location search response

pagination

object

Pagination response

Show child attributes

pagination.limit

integer<int32>

default:10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

pagination.offset

integer<int32>

default:0

Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

Required range: x >= 0

Example:

1

pagination.count

integer<int32>

Total number of search results

Example:

1000

data

object[]

Show child attributes

data.locationNumber

integer<int32>

required

A merchant-defined unique identifier used to reference the location.

Example:

23

data.name

string

required

The display name of the location, typically shown in the User Interface and reports.

Example:

"Seattle Store"

data.locationId

string

A system-generated globally unique identifier for the location.

Example:

"9372919a8219e8"

data.isActive

boolean

Indicates whether the location is currently active for order fulfillment. true Location is active. false Location is inactive.

Example:

true

data.address

object

The physical address associated with the location.

Show child attributes

data.address.region

string

required

Region or state

Example:

"WA"

data.address.addressLine1

string

Address line 1

Example:

123

data.address.addressLine2

string

Address line 2

Example:

"Suite 100"

data.address.addressLine3

string

Address line 3

Example:

"Seventh floor"

data.address.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

data.address.city

string

City name

Example:

"Seattle"

data.address.countryCode

string

ISO 3166-1 alpha-2 based country code

Example:

"US"

data.address.postalCode

string

Postal or ZIP code

Example:

98121

data.address.type

string

Address type

Example:

"Home"

data.address.contacts

object[]

Show child attributes

data.address.contacts.type

string

Contact type

Example:

"OFFICE"

data.address.contacts.email

string

E-mail address

Example:

"[email protected]"

data.address.contacts.phone

object[]

Show child attributes

data.address.contacts.phone.number

string

Phone number

Example:

"0281923712"

data.address.contacts.phone.type

string

Phone type

Example:

"MOBILE"

data.address.contacts.name

object

Contact person's name for the location

Show child attributes

data.address.contacts.name.firstName

string

First name

Example:

"Pat"

data.address.contacts.name.middleName

string

Middle name or initial

Example:

"E"

data.address.contacts.name.lastName

string

Last name

Example:

"Kake"

data.type

string

The type or classification of the location (for example, DC for Distribution Center, Store).

Example:

"DC"

data.capacity

object

Capacity limits and allocation settings that define how many orders the location can fulfill.

Show child attributes

data.capacity.maxAllocations

integer<int32>

Maximum allocations this location can take at any given time. When currentAllocations=maxAllocations, this location is AtCapacity and cannot take any further allocations.

Example:

30

data.capacity.currentAllocations

integer<int32>

Current allocations at this location.

Example:

5

data.capacity.infiniteAllocation

boolean

data.capacity.allocationPercentage

integer<int32>

Current percentage of allocations at this location. Calculated by (currentAllocations / maxAllocations)*100.

Example:

20

data.capacity.isCapacityFull

boolean

If location has no allocation capacity limit.

Example:

true

data.services

object

Custom service-level attributes associated with the location. Often used for filtering or routing (for example, by brand or channel).

Example:

{ "brand": "WHBM", "channel": "Frontline" }

data.zones

string[]

A list of shipping zones associated with the location for delivery or operational routing.

data.createdAt

string<date-time>

The timestamp of when the location record was created, in ISO 8601 UTC format.

Example:

"2022-05-25T07:58:30.996Z"

data.updatedAt

string<date-time>

The timestamp of the most recent update to the location record, in ISO 8601 UTC format.

Example:

"2022-05-25T07:58:30.996Z"

data.operatingHours

object[]

Weekly schedule detailing the hours during which the location operates.

Show child attributes

data.operatingHours.day

enum<string>

Day of week

Available options:

SUNDAY,

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY

Example:

"SUNDAY"

data.operatingHours.hours

object[]

Show child attributes

data.operatingHours.hours.open

string

Store opening time, measured in 24-hour format

Example:

10

data.operatingHours.hours.close

string

Closing time for given hour type

Example:

20

data.operatingHours.hours.type

string

Type of location operation

Example:

"PICK_UP"

data.coordinates

object

The geographical coordinates of the location in GeoJSON format. Must follow the format [longitude, latitude], where longitude ∈ [-180, 180] and latitude ∈ [-90, 90].

Show child attributes

data.coordinates.type

string

Geo coordinate type

Example:

"Point"

data.coordinates.coordinates

string<double>[]

Coordinate value

Example:

{
  "type": "Point",
  "coordinates": [-122.3493, 47.6205]
}

data.attributes

object

Custom key-value metadata or flags associated with the location.

Example:

{ "isReturns": "true" }

data.supportedCarriers

object[]

A list of shipping carriers supported by this location for outbound or inbound logistics.

Show child attributes

data.supportedCarriers.carrier

string

Carrier name

Example:

"FedEx"

data.supportedCarriers.serviceLevels

object[]

Show child attributes

data.supportedCarriers.serviceLevels.name

string

The name of the external shipping carrier providing the service.

Example:

"FedEx"

data.supportedCarriers.serviceLevels.shippingMethod

string

The name of the corresponding shipping method as defined in fabric's system.

Example:

"FedEx"

data.activeFulfillmentMethods

object

A map of fulfillment methods currently active and supported by this location (for example, ShipToHome, Pickup).

Example:

{ "ShipToHome": "true" }

data.transfer

object

Transfer configuration settings for inventory movement related to this location.

Show child attributes

data.transfer.isAutoReceiving

boolean

Enable or disable auto receiving for transfer

data.transfer.autoStockWindow

string

Sets the auto stock window for location transfer

Example:

"PT10M"

stats

string[]

Stats Details

Get a specific location Create Outage

⌘I

Orders & Inventory

Order User Guides

Inventory User Guides

Orders API Endpoints

Inventory API Endpoints

Get locations by query

Authorizations

Headers

Query Parameters

Body

Response