Search for allocations by query

Search for inventory allocations based on the matching filter criteria.

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-channel-id

string

required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Query Parameters

offset

integer

default: 0

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

limit

integer

default: 10

Maximum number of records per page

Required range: 1 < x < 100

Body

application/json

Sample request to search allocations

filters

object[]

required

• Option 1
• Option 2

Show child attributes

sort

string

default: -allocation.createdAt

Property by which data is sorted

stats

object

The stats filter resource.

Show child attributes

Response

200 - application/json

Allocation search response details

data

object[]

Show child attributes

pagination

object

Pagination response

Show child attributes

stats

string[]

A list of stats.