Update Inventory Hold

Replaces the products covered by an inventory hold placed on an ASN, addressed by its inventory_hold_uuid. The hold may have been created through this API or set up for you in the ShipMonk app.

General description

  • The items list is the desired state: products missing from it are released, new ones are added and the rest is left untouched.
  • The same scope must not appear twice in one items list, and an item whose scope another hold on the same ASN already holds is rejected as well.
  • Just like creating a hold, this works only while the receiving's status is awaiting or arrived.
  • A hold that already ended, so its status is released or cancelled, cannot be changed any more.
  • A hold that covers every product of the receiving, shown in the list with sku: null, can only be released; its products can be changed only in the ShipMonk app.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Identifier of the inventory hold to update, as returned when it was created or when the holds are listed.

items
array of objects
required

Products the hold should cover from now on. The list replaces the current one, so items missing from it are released, new items are added and the rest is left untouched.

items*
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