POST
/
locations
curl --request POST \
  --url https://api.fabric.inc/v3/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "activeFulfillmentMethods": {
    "ShipToHome": "true"
  },
  "address": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "contacts": [
      {
        "email": "abc@mail.com",
        "name": {
          "firstName": "Pat",
          "lastName": "Kake",
          "middleName": "E"
        },
        "phone": [
          {
            "number": "0281923712",
            "type": "MOBILE"
          }
        ],
        "type": "OFFICE"
      }
    ],
    "countryCode": "US",
    "postalCode": "98121",
    "region": "WA",
    "type": "Home"
  },
  "attributes": {
    "isReturns": "true"
  },
  "capacity": {
    "allocationPercentage": 20,
    "infiniteAllocation": true,
    "isCapacityFull": true,
    "maxAllocations": 30
  },
  "coordinates": {
    "coordinates": [
      -122.3493,
      47.6205
    ],
    "type": "Point"
  },
  "isActive": true,
  "locationNumber": 23,
  "name": "Seattle Store",
  "operatingHours": [
    {
      "day": "SUNDAY",
      "hours": [
        {
          "close": "20",
          "open": "10",
          "type": "PICK_UP"
        }
      ]
    }
  ],
  "services": {
    "brand": "WHBM",
    "channel": "Frontline"
  },
  "transfer": {
    "autoStockWindow": "PT10M",
    "isAutoReceiving": true
  },
  "type": "DC"
}'
{
  "address": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "contacts": [
      {
        "email": "abc@mail.com",
        "name": {
          "firstName": "Pat",
          "lastName": "Kake",
          "middleName": "E"
        },
        "phone": [
          {
            "number": "0281923712",
            "type": "MOBILE"
          }
        ],
        "type": "OFFICE"
      }
    ],
    "countryCode": "US",
    "postalCode": "98121",
    "region": "WA",
    "type": "Home"
  },
  "capacity": {
    "allocationPercentage": 20,
    "currentAllocations": 5,
    "infiniteAllocation": true,
    "isCapacityFull": true,
    "maxAllocations": 30
  },
  "coordinates": {
    "coordinates": [
      -122.3493,
      47.6205
    ],
    "type": "Point"
  },
  "createdAt": "2022-05-25T07:58:30.996Z",
  "isActive": true,
  "locationId": "9372919a8219e8",
  "locationNumber": 23,
  "name": "Seattle Store",
  "operatingHours": [
    {
      "day": "SUNDAY",
      "hours": [
        {
          "close": "20",
          "open": "10",
          "type": "PICK_UP"
        }
      ]
    }
  ],
  "transfer": {
    "autoStockWindow": "PT10M",
    "isAutoReceiving": true
  },
  "type": "DC",
  "updatedAt": "2022-05-25T07:58:30.996Z"
}

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.

Body

application/json

Location request

​
locationNumber
integer
required

Merchant-specified unique number to identify the location

Example:

23

​
name
string
required

Location name

Example:

"Seattle Store"

​
activeFulfillmentMethods
object

Active fulfilment methods

Example:
{ "ShipToHome": "true" }
​
address
object

Address details

​
attributes
object

Custom location attributes

Example:
{ "isReturns": "true" }
​
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

Example:
{
  "coordinates": [-122.3493, 47.6205],
  "type": "Point"
}
​
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

​
operatingHours
object[]

Location operating hours

Store operating hour

​
services
object

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

Example:
{ "brand": "WHBM", "channel": "Frontline" }
​
transfer
object

Location transfer Model used setup transfer configuration for location

​
type
string

Location type

Example:

"DC"

Response

201
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

​
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

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

​
transfer
object

Location transfer Model used setup transfer configuration for location

​
type
string

Location type

Example:

"DC"

​
updatedAt
string

Time location was last updated

Example:

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