Update a specific location outage

curl --request PUT \
  --url https://api.fabric.inc/v3/location-outages/{outageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "locationNumber": 23,
  "disabledFulfillmentMethods": [
    "<string>"
  ],
  "schedule": {
    "startDate": "2022-05-12T09:30:31Z",
    "endDate": "2022-05-12T09:30:31Z",
    "indefinite": true
  },
  "reasonCode": "maintenance",
  "notes": "Any additional info",
  "createdBy": "Carl Doe",
  "updatedBy": "Carl Doe"
}
'

{
  "locationNumber": 23,
  "disabledFulfillmentMethods": [
    "<string>"
  ],
  "schedule": {
    "startDate": "2022-05-12T09:30:31Z",
    "endDate": "2022-05-12T09:30:31Z",
    "indefinite": true
  },
  "reasonCode": "maintenance",
  "outageId": "9320183a01e214",
  "outageNumber": "OUTAGE1",
  "status": "CREATED",
  "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
    }
  ]
}

PUT

location-outages

{outageId}

Update a specific location outage

curl --request PUT \
  --url https://api.fabric.inc/v3/location-outages/{outageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "locationNumber": 23,
  "disabledFulfillmentMethods": [
    "<string>"
  ],
  "schedule": {
    "startDate": "2022-05-12T09:30:31Z",
    "endDate": "2022-05-12T09:30:31Z",
    "indefinite": true
  },
  "reasonCode": "maintenance",
  "notes": "Any additional info",
  "createdBy": "Carl Doe",
  "updatedBy": "Carl Doe"
}
'

{
  "locationNumber": 23,
  "disabledFulfillmentMethods": [
    "<string>"
  ],
  "schedule": {
    "startDate": "2022-05-12T09:30:31Z",
    "endDate": "2022-05-12T09:30:31Z",
    "indefinite": true
  },
  "reasonCode": "maintenance",
  "outageId": "9320183a01e214",
  "outageNumber": "OUTAGE1",
  "status": "CREATED",
  "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

outageId

string

required

Merchant-specified unique number to identify the location outage

Body

application/json

Request payload used to update an existing outage for a specific location. Allows modifications to fulfillment method availability, scheduling, and related metadata.

locationNumber

integer<int32>

required

The unique identifier of the location impacted by the outage, as defined by the merchant.

Example:

23

disabledFulfillmentMethods

string[]

required

A list of fulfillment methods that will be temporarily disabled during the updated outage period (for example, ShipToHome, Pickup).

A fulfillment method to be disabled for the duration of the outage.

schedule

object

required

The updated time window during which the outage will be in effect.

Show child attributes

schedule.startDate

string<date-time>

required

outage created date

Example:

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

schedule.endDate

string<date-time>

outage created date

Example:

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

schedule.indefinite

boolean

reasonCode

string

required

A merchant-defined reason for the outage update, used for operational tracking (for example, maintenance, severe weather, staffing).

Example:

"maintenance"

notes

string

Optional notes or comments providing additional context for the outage update.

Example:

"Any additional info"

createdBy

string

Identifier of the user or system that originally created the outage record.

Example:

"Carl Doe"

updatedBy

string

Identifier of the user or system making this update.

Example:

"Carl Doe"

Response

Location outage updated

Response object representing a scheduled outage at a specific location, including status, duration, fulfillment impact, and auditing information.

locationNumber

integer<int32>

required

The unique identifier of the location affected by the outage, as defined by the merchant.

Example:

23

disabledFulfillmentMethods

string[]

required

A list of fulfillment methods that are disabled during the outage period (for example, ShipToHome, Pickup).

A fulfillment method that will be unavailable during the outage.

schedule

object

required

The date and time range during which the outage is scheduled to occur.

Show child attributes

schedule.startDate

string<date-time>

required

outage created date

Example:

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

schedule.endDate

string<date-time>

outage created date

Example:

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

schedule.indefinite

boolean

reasonCode

string

required

A merchant-defined reason for initiating the outage (for example, maintenance, staffing, system upgrade).

Example:

"maintenance"

outageId

string

A system-generated unique identifier for the outage event.

Example:

"9320183a01e214"

outageNumber

string

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

Example:

"OUTAGE1"

status

enum<string>

The current status of the outage lifecycle.

Available options:

CREATED,

STARTED,

ENDED,

CANCELLED

Example:

"CREATED"

notes

string

Optional notes or additional context related to the outage.

Example:

"Any additional info"

createdBy

string

The user or system that originally created the outage record.

Example:

"Carl Doe"

createdAt

string<date-time>

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

Example:

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

updatedBy

string

The user or system that last modified the outage record.

Example:

"Carl Doe"

updatedAt

string<date-time>

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

Example:

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

auditLogs

object[]

A list of audit log entries capturing changes and actions performed on the outage record.

Show child attributes

auditLogs.lineItemId

string

Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it during order creation, in UUID format.

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

auditLogs.auditId

string

System-generated audit ID (UUID format)

Example:

"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111"

auditLogs.auditType

string

Audit type such as cancel, return, etc.

Example:

"CANCEL"

auditLogs.employeeId

string

Employee (ID or name) who made the last update

Example:

6227

auditLogs.auditedAt

string<date-time>

Audit time (UTC)

Example:

"2023-03-12T09:24:54.804Z"

auditLogs.source

string

Merchant-defined source from where the update was initiated. There are no predefined values; possible values could be Customer Service Representative (CSR), Point-of-Sale (POS), etc.

Example:

"POS"

auditLogs.reasonCode

string

Merchant-defined reason code, varies from merchant to merchant

Example:

"Scratched item"

auditLogs.subReasonCode

string

Merchant-defined sub reason code; provides more clarity to audit reason

Example:

"Scratched item"

auditLogs.policyCode

string

Configurable in Copilot as per requirement. If omitted, default policy is used.

Example:

"POS"

auditLogs.note

string

Additional info, if any

Example:

"Note"

auditLogs.lineItemNumber

integer<int32>

Item identifier

Example:

1

auditLogs.sku

string

Stock keeping unit (SKU), unique item identifier

Example:

"SKU0023"

auditLogs.quantity

integer<int32>

Ordered quantity of given item

Example:

1

auditLogs.amount

number<double>

Amount for which audit is done

Example:

2.4

auditLogs.paymentToken

object

Payment token provided by payment provider. Must be provided during order creation if the payment life cycle orchestration is through fabric Orders (OMS).

Show child attributes

auditLogs.paymentToken.token

string

Payment token provided by payment provider

Example:

"pi_34tr6787rt"

auditLogs.paymentToken.paymentType

string

Payment type, for example, credit card payment providers can be Visa, Mastercard, American express, etc.

Example:

"VISA"

auditLogs.updatedFields

object[]

Show child attributes

auditLogs.updatedFields.fieldName

string

Field or property name that was updated

Example:

"UOM"

auditLogs.updatedFields.fieldOriginalValue

string

Original value of fieldName before it was updated

Example:

"PK"

auditLogs.attributes

object

Custom attributes

Example:

{ "key": "value" }

auditLogs.isSuccess

boolean

default:false

true: Update operation (any update to the service) is successful
false: Update operation has failed

Example:

true

Cancel outage using outageNumber Cancel outage

⌘I

Orders & Inventory

Order User Guides

Inventory User Guides

Orders API Endpoints

Inventory API Endpoints

Update a specific location outage

Authorizations

Headers

Path Parameters

Body

Response