Get LocationOutages by query

Getting Started

Authentication v3

Concepts
System Apps
User Apps
Authentication Endpoints

Product Catalog

Product Catalog API - Overview
Developer Guide
Data Ingestion Best Practices
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products

Orders

Orders (3.0.0)
Developer Guide
Orders FAQ
Shopping Lists
Shipping Methods
Imports
Exports
Orders
Frauds
Notifications
Backorders Preorders
Cancellations
Allocations
Shipments
Inventory Transfers
Tracking
Invoices
Payments
Credits
Appeasements
Returns

Inventory

Integrations

Offers

Offers (3.0.0)
Developer Guide
Real-time Pricing Engine
Price Lists
Prices
Price Types
Price Controls
Price Methods
Priced Products
Add-ons
Promotions
Coupons
Coupon Codes
Redemptions
Product Exclusion Lists
Segments
Imports
Exports
Attributes
Webhook Events

Carts

Overview
Developer Guides
Carts
Order Draft
Items
Addresses
Payments
Fulfillment
Customer
Coupons
Validations
Cart Orchestrator

Customers

Customer Profile
Customer Address
Customer Self

POST

location-outages

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.

Query Parameters

offset

number

default: 0

The number of records to skip before returning all records. The default is 0 when no value is specified.

limit

number

default: 10

The maximum number of records per page.

Body

application/json

outage search request

filters

object[]

required

sort

string

default: -outage.createdAt

Resource property on which data needed to be sorted on.

Response

200 - application/json

Outage search response

data

object[]

data.auditLogs

object[]

Change history details

data.auditLogs.amount

number

Amount for which audit is done

data.auditLogs.auditId

string

System-generated audit ID (UUID format)

data.auditLogs.auditType

string

Audit type such as cancel, return, etc.

data.auditLogs.auditedAt

string

Audit time (UTC)

data.auditLogs.employeeId

string

Employee (ID or name) who made the last update

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

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

data.auditLogs.lineItemNumber

integer

Item identifier

data.auditLogs.note

string

A note string that stores additional info.

data.auditLogs.paymentToken

object

Order payment token details

data.auditLogs.policyCode

string

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

data.auditLogs.quantity

integer

The total quantity of a specific item in an order.

data.auditLogs.reasonCode

string

Merchant-defined reason code, varies from merchant to merchant

data.auditLogs.sku

string

Stock keeping unit (SKU), unique item identifier

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

data.auditLogs.subReasonCode

string

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

data.auditLogs.updatedFields

object[]

Audit log for change history

data.createdAt

string

outage created date

data.createdBy

string

Who triggered the outage response.

data.disabledFulfillmentMethods

string[]

required

Fulfillment methods disabled

data.locationNumber

integer

required

The merchant-specified unique number to identify a location.

data.notes

string

Placeholder for additional info, if any.

data.outageId

string

Unique ID for outage

data.outageNumber

string

The merchant-specified unique number to identify the outage.

data.reasonCode

string

required

The merchant-defined reason code for the outage.

data.schedule

object

required

Schedule of outage

data.status

enum<string>

Outage status

Available options:

CREATED,

STARTED,

ENDED,

CANCELLED

data.updatedAt

string

Time of last update to outage (UTC)

data.updatedBy

string

The last person to update the outage.

pagination

object

An object containing the pagination response data.

Was this page helpful?

Create Outage Update an outage by outageNumber