Search Overrides

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.

Query Parameters

offset

number

default:0

Number of records to skip before returning all records. Default is 0 when no value is specified.

Example:

1

limit

number

default:10

Maximum number of records per page

Example:

10

Body

application/json

Capacity Override search request

filters

object[]

required

Maximum array length: 50

Show child attributes

filters.field

string

required

The field name to apply the filter on. Must follow the format capacityOverride.<fieldName>.

Example:

"capacityOverride.status"

filters.condition

enum<string>

default:EQ

Type of condition to apply

EQ: Equal to
NEQ: Not equal to
IN: Included in list
NIN: Not included in list
LT: Less than
GT: Greater than
LTE: Less than or equal to
GTE: Greater than or equal to

Available options:

EQ,

NEQ,

IN,

NIN,

LT,

GT,

LTE,

GTE

Example:

"EQ"

filters.group

string

default:Default

Optional group name to logically separate filter criteria for compound queries.

Example:

"GroupA"

sort

string

default:-capacityOverride.createdAt

Resource property on which data needed to be sorted on.

Example:

"+capacityOverride.createdAt"

Response

Response object returned after searching for Capacity Overrides. Includes paginated data and optional summary statistics.

pagination

object

Pagination response

Show child attributes

pagination.limit

integer<int32>

default:10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

pagination.offset

integer<int32>

default:0

Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

Required range: x >= 0

Example:

1

pagination.count

integer<int32>

Total number of search results

Example:

1000

data

object[]

A list of Capacity Override records that match the search criteria.

Show child attributes

data.capacity

integer<int32>

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

data.schedule

object

required

The date and time window during which the capacity override is in effect.

Show child attributes

data.schedule.startDate

string<date-time>

required

ISO 8601 formatted timestamp representing when the override becomes active.

Example:

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

data.schedule.endDate

string<date-time>

required

ISO 8601 formatted timestamp representing when the override ends.

Example:

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

data.reasonCode

string

required

A merchant-defined reason for the override, used for traceability or reporting (for example, holiday, peak demand).

Example:

"holiday"

data.capacityOverrideId

string

A system-generated unique identifier for the capacity override.

Example:

"9320183a01e214"

data.capacityOverrideNumber

string

A merchant-defined unique reference number for the capacity override.

Example:

"capacityOverride1"

data.locationNumber

string

A unique identifier for the location where the capacity override applies, as defined by the merchant.

Example:

"23"

data.status

enum<string>

The current status of the capacity override.

Available options:

CREATED,

STARTED,

ENDED,

CANCELLED

Example:

"CREATED"

data.notes

object

Optional notes or comments providing additional context for the override.

Show child attributes

data.notes.createdAt

string

Time note was created (UTC)

Example:

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

data.notes.user

string

Customer Service Representative or Employee (ID or name) who created the note

Example:

"62272e917b12209e68751d94"

data.notes.notes

string

Additional info about the order, if any

Example:

"Fragile - handle with care"

Example:

"Any additional info"

data.createdBy

string

Identifier or name of the user or system that created the override.

Example:

"Carl Doe"

data.createdAt

string<date-time>

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

Example:

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

data.updatedBy

string

Identifier or name of the user or system that last updated the override.

Example:

"Carl Doe"

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

data.auditLogs

object[]

A list of audit log entries tracking changes made to the override.

Show child attributes

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

data.auditLogs.auditId

string

System-generated audit ID (UUID format)

Example:

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

data.auditLogs.auditType

string

Audit type such as cancel, return, etc.

Example:

"CANCEL"

data.auditLogs.employeeId

string

Employee (ID or name) who made the last update

Example:

6227

data.auditLogs.auditedAt

string<date-time>

Audit time (UTC)

Example:

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

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.

Example:

"POS"

data.auditLogs.reasonCode

string

Merchant-defined reason code, varies from merchant to merchant

Example:

"Scratched item"

data.auditLogs.subReasonCode

string

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

Example:

"Scratched item"

data.auditLogs.policyCode

string

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

Example:

"POS"

data.auditLogs.note

string

Additional info, if any

Example:

"Note"

data.auditLogs.lineItemNumber

integer<int32>

Item identifier

Example:

1

data.auditLogs.sku

string

Stock keeping unit (SKU), unique item identifier

Example:

"SKU0023"

data.auditLogs.quantity

integer<int32>

Ordered quantity of given item

Example:

1

data.auditLogs.amount

number<double>

Amount for which audit is done

Example:

2.4

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

data.auditLogs.paymentToken.token

string

Payment token provided by payment provider

Example:

"pi_34tr6787rt"

data.auditLogs.paymentToken.paymentType

string

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

Example:

"VISA"

data.auditLogs.updatedFields

object[]

Show child attributes

data.auditLogs.updatedFields.fieldName

string

Field or property name that was updated

Example:

"UOM"

data.auditLogs.updatedFields.fieldOriginalValue

string

Original value of fieldName before it was updated

Example:

"PK"

data.auditLogs.attributes

object

Custom attributes

Example:

{ "key": "value" }

data.auditLogs.isSuccess

boolean

default:false

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

Example:

true

stats

string[]

An array of summary statistics or aggregated data related to the search.

Orders & Inventory

Order User Guides

Inventory User Guides

Orders API Endpoints

Inventory API Endpoints

Search Overrides

Authorizations

Headers

Query Parameters

Body

Response