Order webhooks

Types of triggers

Webhooks can be triggered on the following events related to movement orders.

Movement order is created

This webhook will fire when a movement order is created.

Movement order is updated

This webhook will fire when a movement order is updated.

Movement order is executed

This webhook will fire when a movement order is executed.

Movement order is deleted

This webhook will fire when a movement order is deleted.

Payload

Example

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

{
  "webhookMovementArticleItemsId": 0,
  "webhookEventId": 0,
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "goodsOwnerId": 0,
  "article": {
    "articleSystemId": 0,
    "articleNumber": "string"
  },
  "movement": {
    "workOrderId": 0,
    "movementArticleItemId": 0,
    "movementArticleItemTypeId": null,
    "isExecuted": false,
    "assignedUserId": null,
    "isStarted": false,
    "toLocation": {
      "location": "string",
      "locationId": null,
      "locationType": {
        "locationTypeId": 0
      }
    }
  },
  "articleItem": {
    "articleItemId": 0,
    "originalArticleItemId": 0,
    "currentLocation": {
      "locationId": null,
      "location": "string",
      "locationType": {
        "locationTypeId": 0
      }
    },
    "serial": "string",
    "batch": "string",
    "numberOfItems": 0.0
  },
  "byComputer": {
    "computerId": 0,
    "computerName": "string"
  },
  "byUser": {
    "userId": 0
  },
  "webhookTemplate": "string",
  "order": {
    "orderId": 0
  },
  "goodsOwnerName": "string"
}

Specification

WebhookMovementArticleItemPayload
webhookMovementArticleItemsId	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.
article	ArticleInfo	Information about the article (SKU).
movement	MovementInfo	Information about the movement.
articleItem	ArticleItemInfo	Information about the particular item which was moved.
byComputer	ByComputerInfo	An element of type ByComputerInfo.
byUser	ByUserInfo	An element of type ByUserInfo.
webhookTemplate	string	The name of the webhook type.
order	OrderInfo	An element of type OrderInfo.
goodsOwnerName	string

ArticleInfo
articleSystemId	int
articleNumber	string

MovementInfo
workOrderId	int
movementArticleItemId	int
movementArticleItemTypeId	int (nullable)
isExecuted	boolean
assignedUserId	int (nullable)
isStarted	boolean
toLocation	ToLocation	An element of type ToLocation.

ToLocation
location	string
locationId	int (nullable)
locationType	LocationType	An element of type LocationType.

LocationType
locationTypeId	int

ArticleItemInfo
articleItemId	int
originalArticleItemId	int
currentLocation	CurrentLocation	An element of type CurrentLocation.
serial	string
batch	string
numberOfItems	decimal

CurrentLocation
locationId	int (nullable)
location	string
locationType	LocationType	An element of type LocationType.

LocationType
locationTypeId	int

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