POST
/
shipments
/
inventory-transfer
/
query

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

Merchant's 24-character tenant ID

x-fabric-channel-id
string
required

Sales channel ID

x-fabric-request-id
string

Unique request ID

Body

application/json
filters
object
required

A query used to filter your records. The query structure should match the target entity ( for example, order, shipment, etc) structure.

limit
integer
default: 10

The maximum number of records per page.

offset
integer
default: 0

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

sortBy
string
default: updatedAt

The item property that data is sorted on.

sortDirection
enum<string>
default: desc

The direction of the sorting, such as ascending or descending.

Available options:
asc,
desc

Response

200 - application/json
count
integer

The count for the query response.

limit
integer

The maximum number of records per page.

offset
integer

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

Was this page helpful?

Packing and unpackingInventory transfer search