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

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

Library Query Model

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

The library query response model object containing query properties.

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