v1.031

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 — the audit value 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 are asn, on_demand and expiration.

📦 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 receiving status is awaiting or arrived, and a request for an in_progress or received receiving is rejected.
  • Create Inventory Hold and Update Inventory Hold — the sku of an item must match a product of your account whose status is active or blacklisted; a disabled product cannot be held.
  • Create Inventory Hold and Update Inventory Hold — the rejections around item scope are documented now: the sku must 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 one items list, 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 receiving status, also once receiving has started, and a hold still awaiting_review ends cancelled instead of released.
  • Update Inventory Hold (POST /v1/integrations/inventory-hold/update) — the two remaining rejections are documented as well: a hold whose status is released or cancelled cannot be changed any more, and a hold covering every product of the receiving (sku: null) can only be released, never updated. The inventory_hold_uuid of 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) — the status field now says what each of awaiting_review, held, released and cancelled means, including that holds created through this API skip the ShipMonk review and start as held. The type field says what asn, on_demand and expiration cover, and both enums carry the description of every value, so the status filter 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.