POST
/
location-capacity
/
search
Search Overrides
curl --request POST \
  --url https://api.fabric.inc/v3/location-capacity/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "sort": "-capacityOverride.createdAt",
  "filters": [
    {
      "field": "capacityOverride.status",
      "value": "CREATED",
      "condition": "EQ"
    }
  ]
}'
{
  "pagination": {
    "limit": 10,
    "offset": 1,
    "count": 1000
  },
  "data": [
    {
      "capacityOverrideId": "9320183a01e214",
      "capacityOverrideNumber": "capacityOverride1",
      "locationNumber": "23",
      "status": "CREATED",
      "capacity": 30,
      "schedule": {
        "startDate": "2022-05-12T09:30:31Z",
        "endDate": "2022-05-12T09:30:31Z"
      },
      "reasonCode": "holiday",
      "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
        }
      ]
    }
  ],
  "stats": [
    "<string>"
  ]
}

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 length: 50
​
sort
string
default:-capacityOverride.createdAt

Resource property on which data needed to be sorted on.

Example:

"+capacityOverride.createdAt"

Response

OK

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

​
pagination
object

Pagination response

​
data
object[]

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

​
stats
string[]

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