Search for inventory hard reservations

Search for hard reservations based on filter criteria.

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

Body

application/json

Hard reservation search request model

filters

object[]

required

• Option 1
• Option 2

Criteria to find inventories by a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used.

Show child attributes

filters.condition

enum<string>

default:

EQ

required

Filter conditions. EQ (Equal to): Searches for exact match. NEQ (Not equal to): Searches by excluding the specified value. IN: Search for multiple values. NIN (Not IN): Excludes the specified values in the search. LT (Less than): Searches for values that are less than the specified value. GT (Greater than): Search for values that are greater than the specified value. LTE (Less than or equal to): Searches for values that are less than or equal to the specified value. GTE (Greater than or equal to): Searches for values that are greater than or equal to the specified value.

Available options:

EQ,

NEQ,

IN,

NIN,

LT,

GT,

LTE,

GTE

Example:

"EQ"

filters.field

string

required

Field name

Example:

"inventory.sku"

filters.group

string

default:

Default

Group name

Example:

"GroupA"

filters.value

A single value to search inventory

Example:

"SKU"

sort

string

default:

-hardReserve.createdAt

Resource property on which data needs to be sorted on.

Example:

"+hardReserve.createdAt"

Response

200

application/json

OK

Search response

data

object[]

An object containing the inventory import status response details.

Show child attributes

data.createdAt

string

required

Time of import request

Example:

"2022-08-01T18:03:28.483Z"

data.importId

string

required

Imported file's unique ID

Example:

"62ff5c0bec0aed3c86202c32"

data.attributes

object

Custom attributes. This is a placeholder for additional info in key: value pairs

Example:

{ "attribute": "12345" }

data.errorFileUrl

string

Directory path where file uploaded

Example:

"https://example.com/tenant/import/bulk/1654680575676.csv?X-Amz-Security-Token=IQoJb3JpZ2"

data.fileName

string

Uploaded file name

Example:

"orderUpload.csv"

data.finishedAt

string

Date and time file import was completed

Example:

"2022-08-01T18:03:28.483Z"

data.importCount

object

Import count object

Show child attributes

data.importCount.error

integer

Total rows with errors in the file

Example:

2000

data.importCount.processed

integer

Total rows processed in the file. processed = uploaded - error Note: Rows that are not formatted according to system requirements will not be imported.

Example:

8000

data.importCount.uploaded

integer

Total rows in the file

Example:

10000

data.originalFileUrl

string

Path to download the uploaded file

Example:

"https://example.com/tenant/import/bulk/1654680575676.csv?X-Amz-Security-Token=IQoJb3JpZ2"

data.statusCode

enum<string>

Uploaded file's current status

Available options:

INITIATED,

PROCESSING,

COMPLETED,

SYSTEM_ERROR

Example:

"INITIATED"

data.type

enum<string>

Available options:

INVENTORY,

INVENTORY_COUNTERS

Example:

"INVENTORY"

data.updatedAt

string

Date and time record was last modified

Example:

"2022-08-01T20:03:28.483Z"

pagination

object

Pagination response

Show child attributes

pagination.count

integer

Total number of search results

Example:

1000

pagination.limit

integer

default:

10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

pagination.offset

integer

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