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
webhookArticleItemsIdintInternal ID for the webhook.
webhookEventIdintInternal ID for this particular event.
systemstringThe name of the Ongoing WMS instance where the event happened.
timestampstringWhen the event happened.
goodsOwnerIdintThe Ongoing WMS system id for the goods owner.
goodsOwnerNamestring
articleArticleInfoInformation about the article (SKU).
articleItemArticleItemInfoBasic information about the particular item which updated.
previousVersionPreviousVersionAn element of type PreviousVersion.
newVersionNewVersionAn element of type NewVersion.
byComputerByComputerInfoAn element of type ByComputerInfo.
byUserByUserInfoAn element of type ByUserInfo.
webhookTemplatestringThe name of the webhook type.
ArticleInfo
articleSystemIdint
articleNumberstring
ArticleItemInfo
articleItemIdint
originalArticleItemIdint
currentLocationCurrentLocationAn element of type CurrentLocation.
numberOfItemsdecimal
purchaseOrderInfoArticleItemPurchaseOrderInfoAn element of type ArticleItemPurchaseOrderInfo.
CurrentLocation
locationIdint (nullable)
locationstring
warehouseWarehouseInfoAn element of type WarehouseInfo.
WarehouseInfo
warehouseIdint
warehouseCodestring
warehouseNamestring
ArticleItemPurchaseOrderInfo
purchaseOrderIdint
purchaseOrderNumberstring
purchaseOrderLineIdint
purchaseOrderStatusArticleItemPurchaseOrderStatusAn element of type ArticleItemPurchaseOrderStatus.
ArticleItemPurchaseOrderStatus
numberint
PreviousVersion
articleItemStatusArticleItemStatusAn element of type ArticleItemStatus.
serialstring
batchstring
ArticleItemStatus
articleItemStatusIdint
articleItemStatusCodestring
isStatusLockedboolean
isStatusLockedForSaleboolean
NewVersion
articleItemStatusArticleItemStatusAn element of type ArticleItemStatus.
serialstring
batchstring
ArticleItemStatus
articleItemStatusIdint
articleItemStatusCodestring
isStatusLockedboolean
isStatusLockedForSaleboolean
ByComputerInfo
computerIdintOngoing WMS workstation ID of the workstation which the user was logged in to.
computerNamestringOngoing WMS workstation name of the workstation which the user was logged in to.
ByUserInfo
userIdintOngoing WMS user ID of the user who performed the action.