v1.031
about 3 hours ago
The inventory hold reference now defines every value it can return.
The hold status and type fields explain each of their values, the conditions for creating, updating and releasing a hold name the receiving statuses they apply to, and the historical audit value is gone from the hold type, because the list can never return it.
🚀 New Endpoints
None
🛠 Schema & Property Updates
PublicApiInventoryHoldType— theauditvalue was removed. It is a historical hold kind that Inventory Holds List (GET /v1/integrations/inventory-holds-list) never returned, so no client has to handle it. The remaining values areasn,on_demandandexpiration.
📦 New Support Schemas
None
📖 Documentation & Constraints Changes
- Create Inventory Hold (
POST /v1/integrations/inventory-hold) and Update Inventory Hold (POST /v1/integrations/inventory-hold/update) — the receiving condition is now stated as concrete values: a hold can be created or changed while the receivingstatusisawaitingorarrived, and a request for anin_progressorreceivedreceiving is rejected. - Create Inventory Hold and Update Inventory Hold — the
skuof an item must match a product of your account whose status isactiveorblacklisted; adisabledproduct cannot be held. - Create Inventory Hold and Update Inventory Hold — the rejections around item scope are documented now: the
skumust be expected on the receiving, an already held scope (same product, lot number and expiration date) is rejected whether this hold or another hold on the same ASN holds it, the same scope must not appear twice in oneitemslist, a wider and a narrower scope can coexist, and a released scope can be held again. - Release Inventory Hold (
POST /v1/integrations/inventory-hold/release) — releasing works in any receivingstatus, also once receiving has started, and a hold stillawaiting_reviewendscancelledinstead ofreleased. - Update Inventory Hold (
POST /v1/integrations/inventory-hold/update) — the two remaining rejections are documented as well: a hold whosestatusisreleasedorcancelledcannot be changed any more, and a hold covering every product of the receiving (sku: null) can only be released, never updated. Theinventory_hold_uuidof the list says the same. Update and release also state that they accept any hold placed on an ASN, whether it was created through the API or set up for you in the ShipMonk app. - Inventory Holds List (
GET /v1/integrations/inventory-holds-list) — thestatusfield now says what each ofawaiting_review,held,releasedandcancelledmeans, including that holds created through this API skip the ShipMonk review and start asheld. Thetypefield says whatasn,on_demandandexpirationcover, and both enums carry the description of every value, so thestatusfilter explains them as well.
No endpoints, fields, or required-status were removed or changed. The single schema change is an enum value that was never returned, so this version stays fully backward-compatible.