Get locations by query

Getting Started

Authentication v3

Concepts
System Apps
User Apps
Authentication Endpoints

Product Catalog

Product Catalog API - Overview
Developer Guide
Data Ingestion Best Practices
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products

Orders

Orders (3.0.0)
Developer Guide
Orders FAQ
Shopping Lists
Shipping Methods
Imports
Exports
Orders
Frauds
Notifications
Backorders Preorders
Cancellations
Allocations
Shipments
Inventory Transfers
Tracking
Invoices
Payments
Credits
Appeasements
Returns

Inventory

Integrations

Offers

Offers (3.0.0)
Developer Guide
Real-time Pricing Engine
Price Lists
Prices
Price Types
Price Controls
Price Methods
Priced Products
Add-ons
Promotions
Coupons
Coupon Codes
Redemptions
Product Exclusion Lists
Segments
Imports
Exports
Attributes
Webhook Events

Carts

Overview
Developer Guides
Carts
Order Draft
Items
Addresses
Payments
Fulfillment
Customer
Coupons
Validations
Cart Orchestrator

Customers

Customer Profile
Customer Address
Customer Self

POST

locations

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

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

Location search response

data

object[]

data.address

object

Address details

data.capacity

object

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

data.coordinates

object

Location coordinates

data.createdAt

string

Time location was created

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.

data.locationId

string

System-generated unique ID to identify the location

data.locationNumber

integer

required

Merchant-specified unique number to identify the location

data.name

string

required

Location name

data.operatingHours

object[]

Location operating hours

data.transfer

object

Location transfer Model used setup transfer configuration for location

data.type

string

Location type

data.updatedAt

string

Time location was last updated

pagination

object

An object containing the pagination response data.

Was this page helpful?

Get a specific location Create Outage