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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string | null
Defaults to null

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

Inventory Hold Status | null
Defaults to null

Return only holds in this state.

integer
≥ 1
Defaults to 1

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

integer
1 to 100
Defaults to 100

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

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json