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.

Body

application/json

Location request

locationNumber
integer
required

Merchant-specified unique number to identify the location

name
string
required

Location name

activeFulfillmentMethods
object

Active fulfilment methods

address
object

Address details

attributes
object

Custom location attributes

capacity
object

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

coordinates
object

Location coordinates

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.

operatingHours
object[]

Location operating hours

services
object

Custom attributes to define a location. It can also be used to filter the location.

transfer
object

Location transfer Model used setup transfer configuration for location

type
string

Location type

Response

201 - application/json

Location response

locationNumber
integer
required

Merchant-specified unique number to identify the location

name
string
required

Location name

address
object

Address details

capacity
object

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

coordinates
object

Location coordinates

createdAt
string

Time location was created

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.

locationId
string

System-generated unique ID to identify the location

operatingHours
object[]

Location operating hours

transfer
object

Location transfer Model used setup transfer configuration for location

type
string

Location type

updatedAt
string

Time location was last updated