Search for nearby locations

Search for nearby locations based on city name, state, postal code, and other geographical details as mentioned in the request body.

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

integer

default:

0

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

Example:

0

limit

integer

default:

10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

Body

application/json

Criteria to search geo location

filters

object[]

required

• Option 1
• Option 2

Criteria to find location using a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used.

Show child attributes

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.field

string

required

Field name

Example:

"location.locationNum"

filters.group

string

default:

Default

The group name.

Example:

"GroupA"

filters.value

A single value for field using which data is searched

Example:

"ORDER_CREATE"

origin

object

required

Geo search origin. Must include postalCode OR (city and region).

Show child attributes

origin.city

string

required

City for which location will be searched

Example:

"San Francisco"

origin.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

origin.postalCode

string

required

Postal code from where nearby locations are to be searched

Example:

"94008"

origin.region

string

required

Region for which location will be searched

Example:

"New York"

origin.distanceUnit

enum<string>

default:

MILE

Distance unit

Available options:

MILE,

KILOMETER,

METER

Example:

"MILE"

origin.maxDistance

number

default:

100

Maximum distance (in radius) from the specified postal code within which the location will be searched

Example:

100

origin.minDistance

number

default:

0

Minimum distance (in radius) from the specified postal code within which the location will be searched

Example:

10

Response

200

application/json

OK

Location geo search response

data

object[]

Nearby location response

Show child attributes

data.locationNumber

integer

required

Merchant-specified unique number to identify the location

Example:

23

data.name

string

required

Location name

Example:

"Seattle Store"

data.address

object

Address details

Show child attributes

data.address.region

string

required

Region or state

Example:

"WA"

data.address.addressLine1

string

Address line 1

Example:

"123 Main St."

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.contacts

object[]

Contact details

Contact details

Show child attributes

data.address.contacts.email

string

E-mail address

Example:

"[e-mail]"

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.lastName

string

Last name

Example:

"Kake"

data.address.contacts.name.middleName

string

Middle name or initial

Example:

"E"

data.address.contacts.phone

object[]

Phone number

Phone number details

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.type

string

Contact type

Example:

"OFFICE"

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.capacity

object

Location Capacity Model used by fulfillment specialist to optimize fulfillments across the distribution network and monitor productivity by location

Show child attributes

data.capacity.allocationPercentage

integer

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

Example:

20

data.capacity.currentAllocations

integer

The number of current allocations at this location.

Example:

5

data.capacity.infiniteAllocation

boolean

data.capacity.isCapacityFull

boolean

A boolean used to determine if a location has no allocation capacity limit.

Example:

true

data.capacity.maxAllocations

integer

The maximum allocations this location can take at any given time. When currentAllocations=maxAllocations, this location is AtCapacity and can't take any further allocations.

Example:

30

data.coordinates

object

Location coordinates

Show child attributes

data.coordinates.coordinates

number[]

The location coordinates consist of a coordinate field in the format of [longitude, latitude], where the longitude value must fall between -180 and 180, and the latitude value must be between -90 and 90, both inclusive.

Coordinate value

data.coordinates.type

string

Geo coordinate type

Example:

"Point"

Example:

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

data.createdAt

string

Time location was created

Example:

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

data.distance

number

Store distance from the specified address

Example:

100

data.isActive

boolean

Determines if a location is active and able to fulfill allocations. true: Location is active for order fulfillment operation. false: Location is inactive.

Example:

true

data.locationId

string

System-generated unique ID to identify the location

Example:

"9372919a8219e8"

data.operatingHours

object[]

Location operating hours

Store operating hour

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[]

Store operating hour

Store operating hours

Show child attributes

data.operatingHours.hours.close

string

Closing time for given hour type

Example:

"20"

data.operatingHours.hours.open

string

Store opening time, measured in 24-hour format

Example:

"10"

data.operatingHours.hours.type

string

Type of location operation

Example:

"PICK_UP"

data.transfer

object

Location transfer Model used setup transfer configuration for location

Show child attributes

data.transfer.autoStockWindow

string

Sets the auto stock window for location transfer

Example:

"PT10M"

data.transfer.isAutoReceiving

boolean

Enable or disable auto receiving for transfer

data.type

string

Location type

Example:

"DC"

data.updatedAt

string

Time location was last updated

Example:

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

pagination

object

An object containing the pagination response data.

Show child attributes

pagination.count

integer

The total number of search results.

Example:

1000

pagination.limit

integer

default:

10

The maximum number of records per page.

Required range: 1 <= x <= 100

Example:

10

pagination.offset

integer

default:

0

The 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