Pick order webhooks

Types of triggers

Ongoing WMS has an object called a "pick order", which is used when a warehouse wants to pick multiple orders at the same time.

A pick order consists of several orders. Most webhook users will not need this type of webhook.

If you are interested in when a particular order is picked, we suggest looking at the webhooks for orders or for picking and packing.

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

Pick order is started

This webhook will fire when a pick order is marked as having been started.

Pick order is executed

This webhook will fire when a pick order is marked as having been executed (i.e. finished).

Payload

Example

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

{
  "webhookPickOrderId": 0,
  "webhookEventId": 0,
  "webhookTemplate": "string",
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "goodsOwnerId": 0,
  "goodsOwnerName": "string",
  "pickOrder": {
    "pickOrderId": 0,
    "isStarted": false,
    "isExecuted": false,
    "pickStarted": "2023-01-01T12:00:00",
    "pickFinished": "2023-01-01T12:00:00",
    "pickOrderType": {
      "pickOrderTypeId": 0,
      "pickOrderTypeCode": null
    }
  },
  "byComputer": {
    "computerId": 0,
    "computerName": "string"
  },
  "byUser": {
    "userId": 0
  }
}

Specification

WebhookPickOrderPayload
webhookPickOrderId	int
webhookEventId	int	Internal ID for this particular event.
webhookTemplate	string	The name of the webhook type.
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
pickOrder	PickOrderInfo	An element of type PickOrderInfo.
byComputer	ByComputerInfo	An element of type ByComputerInfo.
byUser	ByUserInfo	An element of type ByUserInfo.

PickOrderInfo
pickOrderId	int
isStarted	boolean
isExecuted	boolean
pickStarted	dateTime (nullable)
pickFinished	dateTime (nullable)
pickOrderType	PickOrderTypeInfo	An element of type PickOrderTypeInfo.

PickOrderTypeInfo

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.