Packing, packing and returns webhooks

Types of triggers

Webhooks can be triggered on the following events related to picking, packing and return transactions.

Article is allocated

This webhook will fire when an article is allocated.

Article is picked

This webhook will fire when an article is picked.

Article is packed

This webhook will fire when an article is packed.

Article is returned

This webhook will fire when an article is returned. An exception is inbounds performed against purchase order which has been marked as return which will not trigger this weebhook.For that case see inbound webhook.

Article is deallocated

This webhook will fire when an article is deallocated.

Payload

Example

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

{
  "webhookPickingId": 0,
  "webhookEventId": 0,
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "goodsOwnerId": 0,
  "goodsOwnerName": "string",
  "isAllocated": false,
  "isPicked": false,
  "isPacked": false,
  "isReturned": false,
  "isDeleted": false,
  "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,
    "location": {
      "location": "string",
      "locationId": 0
    },
    "returnCause": {
      "returnCauseId": 0,
      "returnCauseCode": "string",
      "returnCauseName": "string"
    },
    "orderPalletItem": {
      "palletItemId": 0,
      "palletItemLabelId": "string"
    }
  },
  "byComputer": {
    "computerId": 0,
    "computerName": "string"
  },
  "byUser": {
    "userId": 0
  },
  "order": {
    "orderId": 0,
    "orderNumber": "string",
    "orderLine": {
      "orderLineId": 0,
      "rowNumber": "string",
      "parentOrderLine": null
    }
  },
  "webhookTemplate": "string"
}

Specification

WebhookPickingPayload
webhookPickingId	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
isAllocated	boolean
isPicked	boolean
isPacked	boolean
isReturned	boolean
isDeleted	boolean
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.
order	OrderInfo	An element of type OrderInfo.
webhookTemplate	string	The name of the webhook type.

ArticleInfo
articleSystemId	int
articleNumber	string
barCode	string

ArticleItemInfo
articleItemId	int
originalArticleItemId	int
serial	string
batch	string
expiryDate	dateTime (nullable)
numberOfItems	decimal
location	CurrentLocationInfo	An element of type CurrentLocationInfo.
returnCause	ReturnCause	An element of type ReturnCause.
orderPalletItem	OrderPalletItemInfo	An element of type OrderPalletItemInfo.

CurrentLocationInfo
location	string
locationId	int

ReturnCause
returnCauseId	int
returnCauseCode	string
returnCauseName	string

OrderPalletItemInfo
palletItemId	int
palletItemLabelId	string

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.

OrderInfo
orderId	int
orderNumber	string
orderLine	OrderLineInfo	An element of type OrderLineInfo.

OrderLineInfo
orderLineId	int
rowNumber	string
parentOrderLine	OrderLineInfo	An element of type OrderLineInfo.