Article item webhooks

Types of triggers

Webhooks can be triggered on the following events related to article items.

Article item status is changed

This webhook will fire when the item status of an article item is changed.

Payload

Example

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

{
  "webhookArticleItemsId": 0,
  "webhookEventId": 0,
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "goodsOwnerId": 0,
  "goodsOwnerName": "string",
  "article": {
    "articleSystemId": 0,
    "articleNumber": "string"
  },
  "articleItem": {
    "articleItemId": 0,
    "originalArticleItemId": 0,
    "currentLocation": {
      "locationId": null,
      "location": "string",
      "warehouse": {
        "warehouseId": 0,
        "warehouseCode": "string",
        "warehouseName": "string"
      }
    },
    "numberOfItems": 0.0,
    "purchaseOrderInfo": {
      "purchaseOrderId": 0,
      "purchaseOrderNumber": "string",
      "purchaseOrderLineId": 0,
      "purchaseOrderStatus": {
        "number": 0
      }
    }
  },
  "previousVersion": {
    "articleItemStatus": {
      "articleItemStatusId": 0,
      "articleItemStatusCode": "string",
      "isStatusLocked": false,
      "isStatusLockedForSale": false
    },
    "serial": "string",
    "batch": "string"
  },
  "newVersion": {
    "articleItemStatus": {
      "articleItemStatusId": 0,
      "articleItemStatusCode": "string",
      "isStatusLocked": false,
      "isStatusLockedForSale": false
    },
    "serial": "string",
    "batch": "string"
  },
  "byComputer": {
    "computerId": 0,
    "computerName": "string"
  },
  "byUser": {
    "userId": 0
  },
  "webhookTemplate": "string"
}

Specification

WebhookArticleItemPayload
webhookArticleItemsId	int	Internal ID for the webhook.
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
article	ArticleInfo	Information about the article (SKU).
articleItem	ArticleItemInfo	Basic information about the particular item which updated.
previousVersion	PreviousVersion	An element of type PreviousVersion.
newVersion	NewVersion	An element of type NewVersion.
byComputer	ByComputerInfo	An element of type ByComputerInfo.
byUser	ByUserInfo	An element of type ByUserInfo.
webhookTemplate	string	The name of the webhook type.

ArticleInfo
articleSystemId	int
articleNumber	string

ArticleItemInfo
articleItemId	int
originalArticleItemId	int
currentLocation	CurrentLocation	An element of type CurrentLocation.
numberOfItems	decimal
purchaseOrderInfo	ArticleItemPurchaseOrderInfo	An element of type ArticleItemPurchaseOrderInfo.

CurrentLocation
locationId	int (nullable)
location	string
warehouse	WarehouseInfo	An element of type WarehouseInfo.

WarehouseInfo
warehouseId	int
warehouseCode	string
warehouseName	string

ArticleItemPurchaseOrderInfo
purchaseOrderId	int
purchaseOrderNumber	string
purchaseOrderLineId	int
purchaseOrderStatus	ArticleItemPurchaseOrderStatus	An element of type ArticleItemPurchaseOrderStatus.

ArticleItemPurchaseOrderStatus
number	int

PreviousVersion
articleItemStatus	ArticleItemStatus	An element of type ArticleItemStatus.
serial	string
batch	string

ArticleItemStatus
articleItemStatusId	int
articleItemStatusCode	string
isStatusLocked	boolean
isStatusLockedForSale	boolean

NewVersion
articleItemStatus	ArticleItemStatus	An element of type ArticleItemStatus.
serial	string
batch	string

ArticleItemStatus
articleItemStatusId	int
articleItemStatusCode	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.