Get a specific location

Get a specific location by location number.

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.

Path Parameters

locationNumber

integer

required

Merchant-specified unique number to identify the location

Response

200

application/json

OK

Location response

locationNumber

integer

required

Merchant-specified unique number to identify the location

Example:

23

name

string

required

Location name

Example:

"Seattle Store"

address

object

Address details

Show child attributes

address.region

string

required

Region or state

Example:

"WA"

address.addressLine1

string

Address line 1

Example:

"123 Main St."

address.addressLine2

string

Address line 2

Example:

"Suite 100"

address.addressLine3

string

Address line 3

Example:

"Seventh floor"

address.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

address.city

string

City name

Example:

"Seattle"

address.contacts

object[]

Contact details

Contact details

Show child attributes

address.contacts.email

string

E-mail address

Example:

"[e-mail]"

address.contacts.name

object

Contact person's name for the location

Show child attributes

address.contacts.name.firstName

string

First name

Example:

"Pat"

address.contacts.name.lastName

string

Last name

Example:

"Kake"

address.contacts.name.middleName

string

Middle name or initial

Example:

"E"

address.contacts.phone

object[]

Phone number

Phone number details

Show child attributes

address.contacts.phone.number

string

Phone number

Example:

"0281923712"

address.contacts.phone.type

string

Phone type

Example:

"MOBILE"

address.contacts.type

string

Contact type

Example:

"OFFICE"

address.countryCode

string

ISO 3166-1 alpha-2 based country code

Example:

"US"

address.postalCode

string

Postal or ZIP code

Example:

"98121"

address.type

string

Address type

Example:

"Home"

capacity

object

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

Show child attributes

capacity.allocationPercentage

integer

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

Example:

20

capacity.currentAllocations

integer

The number of current allocations at this location.

Example:

5

capacity.infiniteAllocation

boolean

capacity.isCapacityFull

boolean

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

Example:

true

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

coordinates

object

Location coordinates

Show child attributes

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

coordinates.type

string

Geo coordinate type

Example:

"Point"

Example:

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

createdAt

string

Time location was created

Example:

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

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

locationId

string

System-generated unique ID to identify the location

Example:

"9372919a8219e8"

operatingHours

object[]

Location operating hours

Store operating hour

Show child attributes

operatingHours.day

enum<string>

Day of week

Available options:

SUNDAY,

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY

Example:

"SUNDAY"

operatingHours.hours

object[]

Store operating hour

Store operating hours

Show child attributes

operatingHours.hours.close

string

Closing time for given hour type

Example:

"20"

operatingHours.hours.open

string

Store opening time, measured in 24-hour format

Example:

"10"

operatingHours.hours.type

string

Type of location operation

Example:

"PICK_UP"

transfer

object

Location transfer Model used setup transfer configuration for location

Show child attributes

transfer.autoStockWindow

string

Sets the auto stock window for location transfer

Example:

"PT10M"

transfer.isAutoReceiving

boolean

Enable or disable auto receiving for transfer

type

string

Location type

Example:

"DC"

updatedAt

string

Time location was last updated

Example:

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