Update a specific location

curl --request PUT \
  --url https://api.fabric.inc/v3/locations/{locationNumber} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '"{\"name\":\"Store 403\",\"number\":403\"}"'

{
  "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"
}

PUT

locations

{locationNumber}

Update a specific location

curl --request PUT \
  --url https://api.fabric.inc/v3/locations/{locationNumber} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '"{\"name\":\"Store 403\",\"number\":403\"}"'

{
  "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.

Path Parameters

locationNumber

string

required

Merchant-specified unique number to identify the location

Body

application/json

Request payload used to update an existing location. Includes changes to fulfillment status, attributes, and operational configuration.

isActive

boolean

Indicates whether the location is active for order fulfillment operations. Use true to activate the location or false to deactivate it.

Example:

true

address

object

The updated physical address of the location.

Show child attributes

type

string

The classification of the location, such as a distribution center (DC), retail store, or third-party logistics facility.

Example:

"DC"

capacity

object

Defines the maximum allocation and throughput limits for the location.

Show child attributes

services

object

Custom key-value attributes that define the location’s services or classification. Often used for filtering or routing.

Example:

{ "brand": "WHBM", "channel": "Frontline" }

operatingHours

object[]

A list of operating hours that define the daily schedule of the location.

Show child attributes

coordinates

object

The geographic coordinates of the location in [longitude, latitude] format. Longitude must be between -180 and 180, and latitude between -90 and 90.

Show child attributes

Example:

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

attributes

object

Additional custom attributes associated with the location.

Example:

{ "isReturns": "true" }

supportedCarriers

object[]

A list of shipping carriers supported by the location.

Show child attributes

activeFulfillmentMethods

object

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

Example:

{ "ShipToHome": "true" }

transfer

object

Configuration for inventory transfer operations involving this location.

Show child attributes

Response

Location updated

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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].

Show child attributes

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.

Show child attributes

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.

Show child attributes

Create a location Delete a location

Orders & Inventory

Order User Guides

Inventory User Guides

Orders API Endpoints

Inventory API Endpoints

Update a specific location

Authorizations

Headers

Path Parameters

Body

Response