Cancel an outage using outageID

POST

location-outages

{outageId}

actions

cancel

curl --request POST \
  --url https://api.fabric.inc/v3/location-outages/{outageId}/actions/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "reasonCode": "NOT_REQUIRED"
}'

{
  "createdAt": "2022-05-12T09:30:31.198Z",
  "createdBy": "Carl Doe",
  "endDate": "2022-05-12T09:30:31.198Z",
  "locationNumber": 23,
  "outageNumber": "OUTAGE1",
  "startDate": "2022-05-12T09:30:31.198Z",
  "status": "CANCELLED",
  "type": "SHIP",
  "updatedAt": "2022-05-12T09:30:31.198Z",
  "updatedBy": "Carl Doe"
}

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

The fabric system-generated unique number to identify the outage.

Body

application/json

Outage cancellation request

reasonCode

string

required

Merchant-defined reason code for the outage

Example:

"NOT_REQUIRED"

Response

200

application/json

Cancelled

Outage response

disabledFulfillmentMethods

string[]

required

Fulfillment methods disabled

locationNumber

integer

required

The merchant-specified unique number to identify a location.

Example:

23

reasonCode

string

required

The merchant-defined reason code for the outage.

Example:

"maintenance"

schedule

object

required

Schedule of outage

auditLogs

object[]

Change history details

Audit log object used to capture change history.

auditLogs.amount

number

Amount for which audit is done

Example:

2.4

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

string

Audit time (UTC)

Example:

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

auditLogs.employeeId

string

Employee (ID or name) who made the last update

Example:

"6227"

auditLogs.isSuccess

boolean

default:false

True indicates the update operation (any update to the service) is successful. <br> False indicates the update operation has failed.

Example:

true

auditLogs.lineItemId

string

The 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.lineItemNumber

integer

Item identifier

Example:

1

auditLogs.note

string

A note string that stores additional info.

Example:

"Note"

auditLogs.paymentToken

object

Order payment token details

auditLogs.policyCode

string

The policy codes are configurable in the Copilot UI. If omitted, fabrics default policy is used.

Example:

"POS"

auditLogs.quantity

integer

The total quantity of a specific item in an order.

Example:

1

auditLogs.reasonCode

string

Merchant-defined reason code, varies from merchant to merchant

Example:

"Scratched item"

auditLogs.sku

string

Stock keeping unit (SKU), unique item identifier

Example:

"SKU0023"

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

string

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

Example:

"Scratched item"

auditLogs.updatedFields

object[]

Audit log for change history

createdAt

string

outage created date

Example:

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

createdBy

string

Who triggered the outage response.

Example:

"Carl Doe"

notes

string

Placeholder for additional info, if any.

Example:

"Any additional info"

outageId

string

Unique ID for outage

Example:

"9320183a01e214"

outageNumber

string

The merchant-specified unique number to identify the outage.

Example:

"OUTAGE1"

status

enum<string>

Outage status

Available options:

CREATED,

STARTED,

ENDED,

CANCELLED

Example:

"CREATED"

updatedAt

string

Time of last update to outage (UTC)

Example:

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

updatedBy

string

The last person to update the outage.

Example:

"Carl Doe"

Was this page helpful?

curl --request POST \
  --url https://api.fabric.inc/v3/location-outages/{outageId}/actions/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "reasonCode": "NOT_REQUIRED"
}'

{
  "createdAt": "2022-05-12T09:30:31.198Z",
  "createdBy": "Carl Doe",
  "endDate": "2022-05-12T09:30:31.198Z",
  "locationNumber": 23,
  "outageNumber": "OUTAGE1",
  "startDate": "2022-05-12T09:30:31.198Z",
  "status": "CANCELLED",
  "type": "SHIP",
  "updatedAt": "2022-05-12T09:30:31.198Z",
  "updatedBy": "Carl Doe"
}

Release Notes

Authorizations

Headers

Path Parameters

Body

Response