POST
/
locations
Create a location
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 '{
  "locationNumber": 23,
  "isActive": true,
  "address": {
    "addressLine1": 123,
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "region": "WA",
    "countryCode": "US",
    "postalCode": 98121,
    "type": "Home",
    "contacts": [
      {
        "type": "OFFICE",
        "email": "abc@mail.com",
        "phone": [
          {
            "number": "0281923712",
            "type": "MOBILE"
          }
        ],
        "name": {
          "firstName": "Pat",
          "middleName": "E",
          "lastName": "Kake"
        }
      }
    ]
  },
  "type": "DC",
  "capacity": {
    "maxAllocations": 30,
    "infiniteAllocation": true,
    "allocationPercentage": 20,
    "isCapacityFull": true
  },
  "services": {
    "brand": "WHBM",
    "channel": "Frontline"
  },
  "operatingHours": [
    {
      "day": "SUNDAY",
      "hours": [
        {
          "open": 10,
          "close": 20,
          "type": "PICK_UP"
        }
      ]
    }
  ],
  "coordinates": {
    "type": "Point",
    "coordinates": [
      -122.3493,
      47.6205
    ]
  },
  "attributes": {
    "isReturns": "true"
  },
  "supportedCarriers": [
    {
      "carrier": "FedEx",
      "serviceLevels": [
        {
          "name": "FedEx",
          "shippingMethod": "FedEx"
        }
      ]
    }
  ],
  "activeFulfillmentMethods": {
    "ShipToHome": "true"
  },
  "transfer": {
    "isAutoReceiving": true,
    "autoStockWindow": "PT10M"
  },
  "name": "Seattle Store"
}'
{
  "locationId": "9372919a8219e8",
  "locationNumber": 23,
  "isActive": true,
  "address": {
    "addressLine1": 123,
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "region": "WA",
    "countryCode": "US",
    "postalCode": 98121,
    "type": "Home",
    "contacts": [
      {
        "type": "OFFICE",
        "email": "abc@mail.com",
        "phone": [
          {
            "number": "0281923712",
            "type": "MOBILE"
          }
        ],
        "name": {
          "firstName": "Pat",
          "middleName": "E",
          "lastName": "Kake"
        }
      }
    ]
  },
  "type": "DC",
  "capacity": {
    "maxAllocations": 30,
    "currentAllocations": 5,
    "infiniteAllocation": true,
    "allocationPercentage": 20,
    "isCapacityFull": true
  },
  "services": {
    "brand": "WHBM",
    "channel": "Frontline"
  },
  "zones": [
    "<string>"
  ],
  "createdAt": "2022-05-25T07:58:30.996Z",
  "updatedAt": "2022-05-25T07:58:30.996Z",
  "operatingHours": [
    {
      "day": "SUNDAY",
      "hours": [
        {
          "open": 10,
          "close": 20,
          "type": "PICK_UP"
        }
      ]
    }
  ],
  "coordinates": {
    "type": "Point",
    "coordinates": [
      -122.3493,
      47.6205
    ]
  },
  "attributes": {
    "isReturns": "true"
  },
  "supportedCarriers": [
    {
      "carrier": "FedEx",
      "serviceLevels": [
        {
          "name": "FedEx",
          "shippingMethod": "FedEx"
        }
      ]
    }
  ],
  "activeFulfillmentMethods": {
    "ShipToHome": "true"
  },
  "transfer": {
    "isAutoReceiving": true,
    "autoStockWindow": "PT10M"
  },
  "name": "Seattle Store"
}

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

Request payload for creating or updating a location. Includes identity, configuration, service capabilities, and operational metadata.

​
locationNumber
integer
required

A merchant-defined unique identifier for the location.

Example:

23

​
name
string
required

The display name or identifier for the location.

Example:

"Seattle Store"

​
isActive
boolean

Indicates whether the location is active for order fulfillment. true Location is active. false Location is inactive.

Example:

true

​
address
object

The physical address associated with the location.

​
type
string

Classification of the location (for example, Distribution Center, Store).

Example:

"DC"

​
capacity
object

The maximum operational capacity and allocation limits for the location.

​
services
object

Custom attributes used to define and categorize the location. These can also be used for filtering and routing logic.

Example:
{ "brand": "WHBM", "channel": "Frontline" }
​
operatingHours
object[]

A list of daily operating hours for the location.

​
coordinates
object

Geographic coordinates of the location in GeoJSON format. Coordinates are in [longitude, latitude] format with longitude in [-180, 180] and latitude in [-90, 90].

Example:
{
  "type": "Point",
  "coordinates": [-122.3493, 47.6205]
}
​
attributes
object

Custom key-value attributes associated with the location. Used to store optional metadata.

Example:
{ "isReturns": "true" }
​
supportedCarriers
object[]

List of shipping carriers supported by the location.

​
activeFulfillmentMethods
object

A map of fulfillment methods that are currently active at the location.

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

Transfer configuration for routing inventory to or from this location.

Response

OK

Response object containing details about a specific location, including its configuration, operational status, capacity, and service attributes.

​
locationNumber
integer
required

A merchant-defined unique identifier used to reference the location.

Example:

23

​
name
string
required

The display name of the location, typically shown in the User Interface and reports.

Example:

"Seattle Store"

​
locationId
string

A system-generated globally unique identifier for the location.

Example:

"9372919a8219e8"

​
isActive
boolean

Indicates whether the location is currently active for order fulfillment. true Location is active. false Location is inactive.

Example:

true

​
address
object

The physical address associated with the location.

​
type
string

The type or classification of the location (for example, DC for Distribution Center, Store).

Example:

"DC"

​
capacity
object

Capacity limits and allocation settings that define how many orders the location can fulfill.

​
services
object

Custom service-level attributes associated with the location. Often used for filtering or routing (for example, by brand or channel).

Example:
{ "brand": "WHBM", "channel": "Frontline" }
​
zones
string[]

A list of shipping zones associated with the location for delivery or operational routing.

​
createdAt
string<date-time>

The timestamp of when the location record was created, in ISO 8601 UTC format.

Example:

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

​
updatedAt
string<date-time>

The timestamp of the most recent update to the location record, in ISO 8601 UTC format.

Example:

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

​
operatingHours
object[]

Weekly schedule detailing the hours during which the location operates.

​
coordinates
object

The geographical coordinates of the location in GeoJSON format. Must follow the format [longitude, latitude], where longitude ∈ [-180, 180] and latitude ∈ [-90, 90].

Example:
{
  "type": "Point",
  "coordinates": [-122.3493, 47.6205]
}
​
attributes
object

Custom key-value metadata or flags associated with the location.

Example:
{ "isReturns": "true" }
​
supportedCarriers
object[]

A list of shipping carriers supported by this location for outbound or inbound logistics.

​
activeFulfillmentMethods
object

A map of fulfillment methods currently active and supported by this location (for example, ShipToHome, Pickup).

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

Transfer configuration settings for inventory movement related to this location.