Inventory webhooks

Types of triggers

Webhooks can be triggered on the following events related to stock adjustment transactions.

Inventory transaction has been performed

This webhook will fire when an inventory transaction is made.

Payload

Example

When the webhook is triggered, the following payload will be delivered to the webhook endpoint.

{
  "webhookInventoryId": 0,
  "webhookEventId": 0,
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "goodsOwnerId": 0,
  "goodsOwnerName": "string",
  "transaction": {
    "transactionNumberOfItems": 0.0,
    "inventoryAdjustmentCause": {
      "id": 0,
      "code": "string"
    },
    "returnRemovedByOrder": {
      "orderId": 0
    }
  },
  "inventory": {
    "inventoryId": 0,
    "isCountInventory": false,
    "inventoryComment": "string"
  },
  "article": {
    "articleSystemId": 0,
    "articleNumber": "string",
    "barCode": "string"
  },
  "articleItem": {
    "articleItemId": 0,
    "originalArticleItemId": 0,
    "serial": "string",
    "batch": "string",
    "expiryDate": "2023-01-01T12:00:00",
    "numberOfItems": 0.0,
    "articleItemStatus": {
      "articleItemStatusId": 0,
      "articleItemStatusCode": "string",
      "articleItemStatusName": "string",
      "isStatusLocked": false,
      "isStatusLockedForSale": false
    }
  },
  "byComputer": {
    "computerId": 0,
    "computerName": "string"
  },
  "byUser": {
    "userId": 0
  },
  "purchaseOrder": {
    "purchaseOrderId": 0,
    "purchaseOrderNumber": "string",
    "purchaseOrderLine": {
      "id": 0,
      "rowNumber": "string"
    }
  },
  "location": {
    "location": "string",
    "locationId": 0,
    "isLocked": false,
    "isLockedForSale": false,
    "warehouse": {
      "warehouseId": 0,
      "warehouseCode": "string",
      "warehouseName": "string"
    }
  },
  "webhookTemplate": "string"
}

Specification

WebhookInventoryPayload
webhookInventoryId	int
webhookEventId	int	Internal ID for this particular event.
system	string	The name of the Ongoing WMS instance where the event happened.
timestamp	string	When the event happened.
goodsOwnerId	int	The Ongoing WMS system id for the goods owner.
goodsOwnerName	string
transaction	InventoryTransaction	An element of type InventoryTransaction.
inventory	InventoryInfo	An element of type InventoryInfo.
article	ArticleInfo	An element of type ArticleInfo.
articleItem	ArticleItemInfo	An element of type ArticleItemInfo.
byComputer	ByComputerInfo	An element of type ByComputerInfo.
byUser	ByUserInfo	An element of type ByUserInfo.
purchaseOrder	PurchaseOrderInfo	An element of type PurchaseOrderInfo.
location	LocationInfo	An element of type LocationInfo.
webhookTemplate	string	The name of the webhook type.

InventoryTransaction
transactionNumberOfItems	decimal
inventoryAdjustmentCause	InventoryAdjustmentCauseInfo	An element of type InventoryAdjustmentCauseInfo.
returnRemovedByOrder	ReturnRemovedByOrder	An element of type ReturnRemovedByOrder.

InventoryAdjustmentCauseInfo
id	int
code	string

ReturnRemovedByOrder
orderId	int

InventoryInfo
inventoryId	int
isCountInventory	boolean
inventoryComment	string

ArticleInfo
articleSystemId	int
articleNumber	string
barCode	string

ArticleItemInfo
articleItemId	int
originalArticleItemId	int
serial	string
batch	string
expiryDate	dateTime (nullable)
numberOfItems	decimal
articleItemStatus	ArticleItemStatusInfo	An element of type ArticleItemStatusInfo.

ArticleItemStatusInfo
articleItemStatusId	int
articleItemStatusCode	string
articleItemStatusName	string
isStatusLocked	boolean
isStatusLockedForSale	boolean

ByComputerInfo
computerId	int	Ongoing WMS workstation ID of the workstation which the user was logged in to.
computerName	string	Ongoing WMS workstation name of the workstation which the user was logged in to.

ByUserInfo
userId	int	Ongoing WMS user ID of the user who performed the action.

PurchaseOrderInfo
purchaseOrderId	int
purchaseOrderNumber	string
purchaseOrderLine	PurchaseOrderLineInfo	An element of type PurchaseOrderLineInfo.

PurchaseOrderLineInfo
id	int
rowNumber	string

LocationInfo
location	string
locationId	int
isLocked	boolean
isLockedForSale	boolean
warehouse	WarehouseInfo	An element of type WarehouseInfo.

WarehouseInfo
warehouseId	int
warehouseCode	string
warehouseName	string