Sign in
Inventory Holds

Retrieve List of Inventory Holds

Returns the inventory holds placed on the account's ASNs, newest first, including the released and cancelled ones.

General description

  • Holds set up for you in the ShipMonk app are listed as well, as long as they are placed on an ASN.
  • Products inside each hold are sorted by SKU, then lot number, then expiration date.
  • Inventory held for other reasons, for example a quarantine on stock already in the warehouse, is not part of this list.
get/v1/integrations/inventory-holds-list

Query parameters

asnstring nullable

Return only holds placed on the receiving with this Advance Shipping Notice (ASN) number.

status'awaiting_review' | 'held' | 'released' | 'cancelled'

Return only holds in this state.

pageinteger

1-based page number to return. Defaults to 1.

pageSizeinteger

Number of holds per page. Defaults to the maximum page size; check the response metadata for the effective size.

Response

Success

Changes

Changed in 1 of the 7 revisions of this API.1