Order webhooks

Types of triggers

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

Order is picked

This webhook will fire when an order's status is changed to Picked or above (400 or above). There must be at least one picked item on the order as well.

Order status is changed

This webhook will fire when an order's status is changed. You can select the statuses you want the webhook to trigger for, e.g. if you want it be triggered whenever an order's status goes to Sent, or when it goes from Open to Released, and so on.

Order is created

This webhook will fire when an order is created.

Payload

Example

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

{
  "webhookOrdersId": 0,
  "webhookEventId": 0,
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "orderId": 0,
  "orderNumber": "string",
  "goodsOwnerId": 0,
  "path": "string",
  "byUser": {
    "userId": 0
  },
  "byComputer": {
    "computerId": 0,
    "computerName": "string"
  },
  "orderStatus": {
    "number": 0
  },
  "currentShipmentId": null,
  "webhookTemplate": "string",
  "goodsOwnerName": "string"
}

Specification

WebhookOrderPayload
webhookOrdersIdintInternal 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.
orderIdintOrder ID.
orderNumberstringOrder number.
goodsOwnerIdintThe Ongoing WMS system id for the goods owner.
pathstringREST API path to the resource.
byUserByUserInfoAn element of type ByUserInfo.
byComputerByComputerInfoAn element of type ByComputerInfo.
orderStatusOrderStatusAn element of type OrderStatus.
currentShipmentIdint (nullable)If the order has been placed on a shipment, this contains the shipment ID.
webhookTemplatestringThe name of the webhook type.
goodsOwnerNamestring
ByUserInfo
userIdintOngoing WMS user ID of the user who performed the action.
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.
OrderStatus
numberintOrder status ID.