Warehouse / Bulk shipments

bulkShipSuggestions

List bulk ship suggestions

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.iduuidAny value
statusenum
CALCULATING
Stock allocation is still running or incomplete.
ON_HOLD
Held while the order has an open exception.
RELEASE
Transitional step while being released; normally becomes QUEUED immediately.
PENDING
On a picklist; picking has not started.
PICKING
Its picklist is being picked.
PICKED
Picked and ready to pack and ship.
PACKING
QUEUED
Released to the warehouse and waiting to be added to a picklist.
UNSCHEDULED
A rule stopped automatic release; it must be scheduled manually.
SHIPPED
release_atdatetimeAny value
reverseBoolean!Default: false

Reverse the order of the underlying list.

sortKeyBulkShipSuggestionsSortKeyDefault: FULFILLMENTS_COUNT

Sort the underlying list using a key.

FULFILLMENTS_COUNT

Returns

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.