Stock Adjustment Notification

When a stock adjustment occurs in the warehouse (e.g. damage, count correction), the WMS sends a notification to the host system.

Direction WMS → Host

HTTP Method POST

Path {host-url}/api/stock-adjustment

Request Body

{
  "warehouseName": "WAREHOUSE_01",
  "warehouseReference": "ADJ-2024-001234",
  "occurredAt": "2024-01-25T10:30:00.000Z",
  "reason": "Damaged during pick",
  "reasonCode": "DAMAGED_IN_WAREHOUSE",
  "fromStatus": "GOOD",
  "toStatus": "DAMAGED",
  "stockAdjustmentDetail": {
    "productId": "PROD-ABC123",
    "quantity": 5,
    "stockOwner": "OWNER_A",
    "batchId": "BATCH-001",
    "expiryDate": "2025-06-30",
    "unitIdentifierCollections": []
  }
}

Field	Type	Description
warehouseName	string	Identifier of the warehouse where the adjustment occurred
warehouseReference	string	Unique reference for this stock adjustment
occurredAt	DateTime	Timestamp when the adjustment took place
reason	string	Human-readable reason for the adjustment
reasonCode	string	Machine-readable reason code
fromStatus	string	Original stock status (GOOD, DAMAGED, HELD, TRANSFER, QA, QC, AGED, KITTING, EXPIRED, DAMAGED_RETURNS, FAULTY_RETURNS)
toStatus	string	New stock status (same values as fromStatus)
stockAdjustmentDetail	object	Details of the affected stock
stockAdjustmentDetail.productId	string	Product identifier
stockAdjustmentDetail.quantity	integer	Quantity adjusted
stockAdjustmentDetail.stockOwner	string	Owner of the stock
stockAdjustmentDetail.batchId	string	Batch identifier
stockAdjustmentDetail.expiryDate	string	Expiry date of the batch
stockAdjustmentDetail.unitIdentifierCollections	array	Collection of unit identifiers (e.g. serial numbers)

Responses

200: Stock adjustment accepted by host