PUT
/
location-capacity
/
{capacityOverrideId}
Update Override
curl --request PUT \
  --url https://api.fabric.inc/v3/location-capacity/{capacityOverrideId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "locationNumber": "23",
  "capacity": 30,
  "schedule": {
    "startDate": "2022-05-12T09:30:31Z",
    "endDate": "2022-05-12T09:30:31Z"
  },
  "reasonCode": "holiday",
  "notes": "Any additional info",
  "createdBy": "Carl Doe",
  "updatedBy": "Carl Doe"
}'
{
  "capacityOverrideId": "9320183a01e214",
  "capacityOverrideNumber": "capacityOverride1",
  "locationNumber": "23",
  "status": "CREATED",
  "capacity": 30,
  "schedule": {
    "startDate": "2022-05-12T09:30:31Z",
    "endDate": "2022-05-12T09:30:31Z"
  },
  "reasonCode": "holiday",
  "notes": "Any additional info",
  "createdBy": "Carl Doe",
  "createdAt": "2022-05-12T09:30:31Z",
  "updatedBy": "Carl Doe",
  "updatedAt": "2022-05-12T09:30:31Z",
  "auditLogs": [
    {
      "lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
      "auditType": "CANCEL",
      "employeeId": 6227,
      "auditedAt": "2023-03-12T09:24:54.804Z",
      "source": "POS",
      "reasonCode": "Scratched item",
      "subReasonCode": "Scratched item",
      "policyCode": "POS",
      "note": "Note",
      "lineItemNumber": 1,
      "sku": "SKU0023",
      "quantity": 1,
      "amount": 2.4,
      "paymentToken": {
        "token": "pi_34tr6787rt",
        "paymentType": "VISA"
      },
      "updatedFields": [
        {
          "fieldName": "UOM",
          "fieldOriginalValue": "PK"
        }
      ],
      "attributes": {
        "key": "value"
      },
      "isSuccess": true
    }
  ]
}

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

​
capacityOverrideId
string
required

Merchant-specified unique number to identify the location CapacityOverride.

Body

application/json

Request payload used to update an existing capacity override for a specific location. Updates include changes to capacity limits, scheduling, or associated metadata.

​
capacity
integer
required

The updated maximum number of allocations that the location can accept at any one time. When currentAllocations equals this value, the location is considered "AtCapacity" and cannot receive additional orders.

Example:

30

​
schedule
object
required

The updated time range during which the capacity override should apply.

​
reasonCode
string
required

A merchant-defined reason for modifying the capacity override (for example, holiday, system outage, staffing changes).

Example:

"holiday"

​
locationNumber
string

A unique identifier for the location affected by the capacity override, as defined by the merchant.

Example:

"23"

​
notes
object

Optional field for any supplemental notes or internal context regarding the update.

​
createdBy
string

The user or system who originally created the capacity override.

Example:

"Carl Doe"

​
updatedBy
string

The user or system who most recently updated the capacity override.

Example:

"Carl Doe"

Response

Location Capacity Override updated

Response object representing a capacity override at a specific location, including status, allocation limit, time window, and audit information.

​
capacity
integer
required

The maximum number of allocations the location can accept at any point during the override period. When currentAllocations equals this value, the location is considered "AtCapacity" and cannot receive further orders.

Example:

30

​
schedule
object
required

The date and time window during which the capacity override is in effect.

​
reasonCode
string
required

A merchant-defined reason for the override, used for traceability or reporting (for example, holiday, peak demand).

Example:

"holiday"

​
capacityOverrideId
string

A system-generated unique identifier for the capacity override.

Example:

"9320183a01e214"

​
capacityOverrideNumber
string

A merchant-defined unique reference number for the capacity override.

Example:

"capacityOverride1"

​
locationNumber
string

A unique identifier for the location where the capacity override applies, as defined by the merchant.

Example:

"23"

​
status
enum<string>

The current status of the capacity override.

Available options:
CREATED,
STARTED,
ENDED,
CANCELLED
Example:

"CREATED"

​
notes
object

Optional notes or comments providing additional context for the override.

​
createdBy
string

Identifier or name of the user or system that created the override.

Example:

"Carl Doe"

​
createdAt
string<date-time>

The timestamp when the capacity override was created, in ISO 8601 UTC format.

Example:

"2022-05-12T09:30:31Z"

​
updatedBy
string

Identifier or name of the user or system that last updated the override.

Example:

"Carl Doe"

​
updatedAt
string<date-time>

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

Example:

"2022-05-12T09:30:31Z"

​
auditLogs
object[]

A list of audit log entries tracking changes made to the override.