POST
/
location-capacity
/
{capacityOverrideId}
/
actions
/
cancel
Cancel Override
curl --request POST \
  --url https://api.fabric.inc/v3/location-capacity/{capacityOverrideId}/actions/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "reasonCode": "NOT_REQUIRED"
}'
{
  "CapacityOverrideNumber": "CapacityOverride1",
  "locationNumber": 23,
  "status": "CANCELLED",
  "type": "SHIP",
  "startDate": "2022-05-12T09:30:31.198Z",
  "endDate": "2022-05-12T09:30:31.198Z",
  "createdBy": "Carl Doe",
  "createdAt": "2022-05-12T09:30:31.198Z",
  "updatedBy": "Carl Doe",
  "updatedAt": "2022-05-12T09:30:31.198Z"
}

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

System-specified unique number to identify the CapacityOverride.

Body

application/json

Request payload used to cancel an existing Capacity Override. Includes a reason for the cancellation, typically used for audit or reporting purposes.

​
reasonCode
string
required

A merchant-defined code indicating the reason for canceling the capacity override.

Example:

"NOT_REQUIRED"

Response

Cancelled

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.