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 |
webhookMovesId | 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. |
isReceive | boolean | |
isMove | boolean | |
article | ArticleInfo | An element of type ArticleInfo. |
movement | MovementInfo | An element of type MovementInfo. |
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. |
webhookTemplate | string | The name of the webhook type. |
ArticleInfo |
articleSystemId | int | |
articleNumber | string | |
barCode | string | |
MovementInfo |
from | From | An element of type From. |
to | To | An element of type To. |
From |
fromLocationId | int | |
fromLocation | string | |
isLocationLocked | boolean | |
isLocationLockedForSale | boolean | |
aisle | AisleInfo | An element of type AisleInfo. |
AisleInfo |
aisleName | string | |
zone | ZoneInfo | An element of type ZoneInfo. |
To |
toLocationId | int | |
toLocation | string | |
isLocationLocked | boolean | |
isLocationLockedForSale | boolean | |
aisle | AisleInfo | An element of type AisleInfo. |
AisleInfo |
aisleName | string | |
zone | ZoneInfo | An element of type ZoneInfo. |
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. |
purchaseOrderType | PurchaseOrderType | An element of type PurchaseOrderType. |
PurchaseOrderLineInfo |
id | int | |
rowNumber | string | |
reportedNumberOfItems | decimal (nullable) | |
PurchaseOrderType |
purchaseOrderTypeId | int | |
purchaseOrderTypeCode | string | |