Skip to main content

warehouseTransfers

Lists the active company’s warehouse transfers, one page at a time.

Business Rules​

  • Reads the company in X-Company-Id only
  • Does not return transfers when transfers are not enabled for the company
  • Sorted by creation date, newest first, unless sortField says otherwise

Error Scenarios​

  • Authentication error when not signed in
  • “Company context is required” when X-Company-Id is missing
  • “You don’t have permission to perform this action.” without the permission

Permissions Required​

  • warehouse:read_transfers
warehouseTransfers(
  after: String
  before: String
  filters: WarehouseTransferFilterInput
  first: Int
  last: Int
  sortField: WarehouseTransferSortFieldEnum = CREATED_AT
  sortOrder: SortTypeEnum = DESC
): WarehouseTransferConnection!

Arguments​

warehouseTransfers.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

warehouseTransfers.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

warehouseTransfers.filters ● WarehouseTransferFilterInput input inventory​

Narrows the transfers returned.

warehouseTransfers.first ● Int scalar common​

Returns the first _n_ elements from the list.

warehouseTransfers.last ● Int scalar common​

Returns the last _n_ elements from the list.

warehouseTransfers.sortField ● WarehouseTransferSortFieldEnum enum inventory​

Field to sort by. Defaults to the creation date.

warehouseTransfers.sortOrder ● SortTypeEnum enum common​

Sort direction. Defaults to descending.

Type​

WarehouseTransferConnection object common​

The connection type for WarehouseTransfer.