Inbound and move webhooks

Types of triggers

Webhooks can be triggered on the following events related to inbound transactions and move transactions.

Inbound transaction has been performed

This webhook will fire when an article is received.

Move transaction has been performed

This webhook will fire when an article is moved.

Payload

Example

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

{
  "webhookMovesId": 0,
  "webhookEventId": 0,
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "goodsOwnerId": 0,
  "isReceive": false,
  "isMove": false,
  "article": {
    "articleSystemId": 0,
    "articleNumber": "string",
    "barCode": "string"
  },
  "movement": {
    "from": {
      "fromLocationId": 0,
      "fromLocation": "string",
      "isLocationLocked": false,
      "isLocationLockedForSale": false,
      "aisle": {
        "aisleName": "string",
        "zone": {
          "zoneName": "string"
        }
      }
    },
    "to": {
      "toLocationId": 0,
      "toLocation": "string",
      "isLocationLocked": false,
      "isLocationLockedForSale": false,
      "aisle": {
        "aisleName": "string",
        "zone": {
          "zoneName": "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",
      "reportedNumberOfItems": null
    },
    "purchaseOrderType": {
      "purchaseOrderTypeId": 0,
      "purchaseOrderTypeCode": "string"
    }
  },
  "webhookTemplate": "string"
}

Specification

WebhookMovesPayload
webhookMovesIdint
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.
isReceiveboolean
isMoveboolean
articleArticleInfoAn element of type ArticleInfo.
movementMovementInfoAn element of type MovementInfo.
articleItemArticleItemInfoAn element of type ArticleItemInfo.
byComputerByComputerInfoAn element of type ByComputerInfo.
byUserByUserInfoAn element of type ByUserInfo.
purchaseOrderPurchaseOrderInfoAn element of type PurchaseOrderInfo.
webhookTemplatestringThe name of the webhook type.
ArticleInfo
articleSystemIdint
articleNumberstring
barCodestring
MovementInfo
fromFromAn element of type From.
toToAn element of type To.
From
fromLocationIdint
fromLocationstring
isLocationLockedboolean
isLocationLockedForSaleboolean
aisleAisleInfoAn element of type AisleInfo.
AisleInfo
aisleNamestring
zoneZoneInfoAn element of type ZoneInfo.
ZoneInfo
zoneNamestring
To
toLocationIdint
toLocationstring
isLocationLockedboolean
isLocationLockedForSaleboolean
aisleAisleInfoAn element of type AisleInfo.
AisleInfo
aisleNamestring
zoneZoneInfoAn element of type ZoneInfo.
ZoneInfo
zoneNamestring
ArticleItemInfo
articleItemIdint
originalArticleItemIdint
serialstring
batchstring
expiryDatedateTime (nullable)
numberOfItemsdecimal
articleItemStatusArticleItemStatusInfoAn element of type ArticleItemStatusInfo.
ArticleItemStatusInfo
articleItemStatusIdint
articleItemStatusCodestring
articleItemStatusNamestring
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.
PurchaseOrderInfo
purchaseOrderIdint
purchaseOrderNumberstring
purchaseOrderLinePurchaseOrderLineInfoAn element of type PurchaseOrderLineInfo.
purchaseOrderTypePurchaseOrderTypeAn element of type PurchaseOrderType.
PurchaseOrderLineInfo
idint
rowNumberstring
reportedNumberOfItemsdecimal (nullable)
PurchaseOrderType
purchaseOrderTypeIdint
purchaseOrderTypeCodestring