Update Stock Status

Request a stock status change (e.g. hold or unhold) for a specific product and stock owner combination. externalReference, productId, and stockOwner are required. batch and toStatus are optional.

Direction Host → WMS

HTTP Method POST

Path /inbound/updateStockStatus

Request Body

{
  "externalReference": "EXT-REF-001",
  "productId": "12345",
  "stockOwner": "OWNER_A",
  "batch": "BATCH-001",
  "toStatus": "HELD"
}

Responses

202: Stock status update accepted

{
  "identifier": "EXT-REF-001-12345-OWNER_A-BATCH-001-HELD",
  "warehouseName": "WAREHOUSE_01",
  "success": true,
  "error": null
}

400: Validation failed (missing required field)

{
  "identifier": "EXT-REF-001-12345--HELD",
  "warehouseName": "WAREHOUSE_01",
  "success": false,
  "error": {
    "errorCode": "400",
    "errorMessage": "MISSING_STOCK_OWNER"
  }
}

500: Internal error (e.g. failed to publish event)