GraphQL API
Warehouse API
Warehouse / Bulk shipments

bulkShipSuggestions

List bulk ship suggestions

Arguments

7 arguments
afterString

A cursor after which elements are returned.

beforeString

A cursor before which elements are returned.

firstInt

Limits number of fetched items. Maximum allowed value: 250.

lastInt

Limits number of fetched items. Maximum allowed value: 250.

queryString

Search and filter expression for bulk ship suggestions. A filter made up of field terms, connectives, modifiers, and comparators. You can apply one or more filters to a query.

Supported filters
organization.iduuid
Any value
statusenum
CALCULATINGON_HOLDRELEASEPENDINGPICKINGPICKEDPACKINGQUEUEDUNSCHEDULEDSHIPPED
release_atdatetime
Any value
reverseBoolean!Default: false

Reverse the order of the underlying list.

sortKeyBulkShipSuggestionsSortKeyDefault: FULFILLMENTS_COUNT

Sort the underlying list using a key.

FULFILLMENTS_COUNT

Possible return

cursorString!

A unique cursor that can be used for pagination.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.