PUT
/
location-outages
/
{outageId}

Authorizations

Authorization
string
headerrequired

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

The merchant-specified unique number to identify the location outage.

Body

application/json

Update outage request

disabledFulfillmentMethods
string[]
required

Fulfillment methods disabled

locationNumber
integer
required

Merchant-specified unique number to identify the location

reasonCode
string
required

Merchant-defined reason code for outage

schedule
object
required

Schedule of outage

createdBy
string

createdBy

notes
string

Placeholder for additional info, if any.

updatedBy
string

updatedBy

Response

200 - application/json

Outage response

disabledFulfillmentMethods
string[]
required

Fulfillment methods disabled

locationNumber
integer
required

The merchant-specified unique number to identify a location.

reasonCode
string
required

The merchant-defined reason code for the outage.

schedule
object
required

Schedule of outage

auditLogs
object[]

Change history details

createdAt
string

outage created date

createdBy
string

Who triggered the outage response.

notes
string

Placeholder for additional info, if any.

outageId
string

Unique ID for outage

outageNumber
string

The merchant-specified unique number to identify the outage.

status
enum<string>

Outage status

Available options:
CREATED,
STARTED,
ENDED,
CANCELLED
updatedAt
string

Time of last update to outage (UTC)

updatedBy
string

The last person to update the outage.

Was this page helpful?

Cancel an outage using outageNumberCancel an outage using outageID