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
webhookMovementArticleItemsIdintInternal 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.
articleArticleInfoInformation about the article (SKU).
movementMovementInfoInformation about the movement.
articleItemArticleItemInfoInformation about the particular item which was moved.
byComputerByComputerInfoAn element of type ByComputerInfo.
byUserByUserInfoAn element of type ByUserInfo.
webhookTemplatestringThe name of the webhook type.
orderOrderInfoAn element of type OrderInfo.
goodsOwnerNamestring
ArticleInfo
articleSystemIdint
articleNumberstring
MovementInfo
workOrderIdint
movementArticleItemIdint
movementArticleItemTypeIdint (nullable)
isExecutedboolean
assignedUserIdint (nullable)
isStartedboolean
toLocationToLocationAn element of type ToLocation.
ToLocation
locationstring
locationIdint (nullable)
locationTypeLocationTypeAn element of type LocationType.
LocationType
locationTypeIdint
ArticleItemInfo
articleItemIdint
originalArticleItemIdint
currentLocationCurrentLocationAn element of type CurrentLocation.
serialstring
batchstring
numberOfItemsdecimal
CurrentLocation
locationIdint (nullable)
locationstring
locationTypeLocationTypeAn element of type LocationType.
LocationType
locationTypeIdint
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.
OrderInfo
orderIdint