Inbound events
These are the inbound events. Each one reaches a webhook subscription as the data of a webhook delivery, whose type is the event type shown under its heading. Every required property is always present; a nullable one may be null.
PurchaseOrderCreated
Section titled “PurchaseOrderCreated”Type: jtWMS.Inbound.Events.V1.PurchaseOrderCreated
Published by the Inbound service when a purchase order is created. Carries the whole purchase order.
Payload: The purchase order just created (Status Open).
| Property | Type | Required | Description |
|---|---|---|---|
PurchaseOrderId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
PoNumber |
string | Yes | |
SupplierName |
string, nullable | Yes | |
ExpectedDate |
string (date), nullable | Yes | |
Status |
string, one of Open, Closed, Cancelled |
Yes | |
Lines |
array of objects | Yes | |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | As entered, in UnitOfMeasureCode. |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].OrderedQuantity |
integer | Yes | In base units. |
Lines[].ReceivedQuantity |
integer | Yes | Posted by receipts on its ASNs, in base units. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes |
PurchaseOrderUpdated
Section titled “PurchaseOrderUpdated”Type: jtWMS.Inbound.Events.V1.PurchaseOrderUpdated
Published by the Inbound service when a purchase order’s header or lines change, including its received totals when a receipt on one of its ASNs is posted. Carries the whole purchase order.
Payload: The whole purchase order after the change.
| Property | Type | Required | Description |
|---|---|---|---|
PurchaseOrderId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
PoNumber |
string | Yes | |
SupplierName |
string, nullable | Yes | |
ExpectedDate |
string (date), nullable | Yes | |
Status |
string, one of Open, Closed, Cancelled |
Yes | |
Lines |
array of objects | Yes | |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | As entered, in UnitOfMeasureCode. |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].OrderedQuantity |
integer | Yes | In base units. |
Lines[].ReceivedQuantity |
integer | Yes | Posted by receipts on its ASNs, in base units. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes |
PurchaseOrderStatusChanged
Section titled “PurchaseOrderStatusChanged”Type: jtWMS.Inbound.Events.V1.PurchaseOrderStatusChanged
Published by the Inbound service when a purchase order is closed or cancelled. Carries the whole purchase order with the previous and new status.
Payload: The whole purchase order after its status changed (Status equals NewStatus).
| Property | Type | Required | Description |
|---|---|---|---|
PurchaseOrderId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
PoNumber |
string | Yes | |
SupplierName |
string, nullable | Yes | |
ExpectedDate |
string (date), nullable | Yes | |
Status |
string, one of Open, Closed, Cancelled |
Yes | |
Lines |
array of objects | Yes | |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | As entered, in UnitOfMeasureCode. |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].OrderedQuantity |
integer | Yes | In base units. |
Lines[].ReceivedQuantity |
integer | Yes | Posted by receipts on its ASNs, in base units. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | |
PreviousStatus |
string, one of Open |
Yes | |
NewStatus |
string, one of Closed, Cancelled |
Yes | |
ChangedAt |
string (date-time) | Yes | The same as UpdatedAt. |
AsnCreated
Section titled “AsnCreated”Type: jtWMS.Inbound.Events.V1.AsnCreated
Published by the Inbound service when an ASN is created, by API, by hand or from a purchase order. Carries the whole ASN.
Payload: The ASN just created (Status Open).
| Property | Type | Required | Description |
|---|---|---|---|
AsnId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
AsnNumber |
string | Yes | |
PurchaseOrderId |
string (uuid), nullable | Yes | |
PurchaseOrderNumber |
string, nullable | Yes | |
SupplierName |
string, nullable | Yes | |
Carrier |
string, nullable | Yes | |
ExpectedArrival |
string (date-time), nullable | Yes | |
DockLocationId |
string (uuid), nullable | Yes | |
Status |
string, one of Open, Receiving, Closed, Cancelled |
Yes | |
Lines |
array of objects | Yes | |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | As entered, in UnitOfMeasureCode (0 for an unplanned line). |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].ExpectedQuantity |
integer | Yes | |
Lines[].ReceivedQuantity |
integer | Yes | Posted, damaged included. |
Lines[].DamagedQuantity |
integer | Yes | |
Lines[].LotNumber |
string, nullable | Yes | |
Lines[].ExpiryDate |
string (date), nullable | Yes | |
Lines[].PurchaseOrderLineId |
string (uuid), nullable | Yes | |
Lines[].Unplanned |
boolean | Yes | Added by receiving a product the ASN did not list. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes |
AsnUpdated
Section titled “AsnUpdated”Type: jtWMS.Inbound.Events.V1.AsnUpdated
Published by the Inbound service when an ASN’s header or lines change, including its received totals when a receipt is posted. Carries the whole ASN.
Payload: The whole ASN after the change.
| Property | Type | Required | Description |
|---|---|---|---|
AsnId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
AsnNumber |
string | Yes | |
PurchaseOrderId |
string (uuid), nullable | Yes | |
PurchaseOrderNumber |
string, nullable | Yes | |
SupplierName |
string, nullable | Yes | |
Carrier |
string, nullable | Yes | |
ExpectedArrival |
string (date-time), nullable | Yes | |
DockLocationId |
string (uuid), nullable | Yes | |
Status |
string, one of Open, Receiving, Closed, Cancelled |
Yes | |
Lines |
array of objects | Yes | |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | As entered, in UnitOfMeasureCode (0 for an unplanned line). |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].ExpectedQuantity |
integer | Yes | |
Lines[].ReceivedQuantity |
integer | Yes | Posted, damaged included. |
Lines[].DamagedQuantity |
integer | Yes | |
Lines[].LotNumber |
string, nullable | Yes | |
Lines[].ExpiryDate |
string (date), nullable | Yes | |
Lines[].PurchaseOrderLineId |
string (uuid), nullable | Yes | |
Lines[].Unplanned |
boolean | Yes | Added by receiving a product the ASN did not list. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes |
AsnStatusChanged
Section titled “AsnStatusChanged”Type: jtWMS.Inbound.Events.V1.AsnStatusChanged
Published by the Inbound service when an ASN starts receiving, is closed or is cancelled. Carries the whole ASN with the previous and new status.
Payload: The whole ASN after its status changed (Status equals NewStatus).
| Property | Type | Required | Description |
|---|---|---|---|
AsnId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
AsnNumber |
string | Yes | |
PurchaseOrderId |
string (uuid), nullable | Yes | |
PurchaseOrderNumber |
string, nullable | Yes | |
SupplierName |
string, nullable | Yes | |
Carrier |
string, nullable | Yes | |
ExpectedArrival |
string (date-time), nullable | Yes | |
DockLocationId |
string (uuid), nullable | Yes | |
Status |
string, one of Open, Receiving, Closed, Cancelled |
Yes | |
Lines |
array of objects | Yes | |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | As entered, in UnitOfMeasureCode (0 for an unplanned line). |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].ExpectedQuantity |
integer | Yes | |
Lines[].ReceivedQuantity |
integer | Yes | Posted, damaged included. |
Lines[].DamagedQuantity |
integer | Yes | |
Lines[].LotNumber |
string, nullable | Yes | |
Lines[].ExpiryDate |
string (date), nullable | Yes | |
Lines[].PurchaseOrderLineId |
string (uuid), nullable | Yes | |
Lines[].Unplanned |
boolean | Yes | Added by receiving a product the ASN did not list. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | |
PreviousStatus |
string, one of Open, Receiving |
Yes | |
NewStatus |
string, one of Receiving, Closed, Cancelled |
Yes | |
ChangedAt |
string (date-time) | Yes | The same as UpdatedAt. |
ReceiptPosted
Section titled “ReceiptPosted”Type: jtWMS.Inbound.Events.V1.ReceiptPosted
Published by the Inbound service when Inventory has posted a receipt (one license plate received against an ASN). Carries the receipt, its lines and the ASN after it.
Payload: A receipt Inventory has posted (Status Posted), with the ASN after it.
| Property | Type | Required | Description |
|---|---|---|---|
ReceiptId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
AsnId |
string (uuid) | Yes | |
AsnNumber |
string | Yes | |
LpnId |
string (uuid) | Yes | |
LpnCode |
string | Yes | |
LpnType |
string, one of Pallet, Case, Tote |
Yes | |
LocationId |
string (uuid) | Yes | |
LocationCode |
string | Yes | |
InventoryTransactionId |
string (uuid) | Yes | |
Status |
string, one of Posted |
Yes | |
Lines |
array of objects | Yes | |
Lines[].ReceiptLineId |
string (uuid) | Yes | |
Lines[].AsnLineId |
string (uuid) | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].BaseQuantity |
integer | Yes | |
Lines[].LotNumber |
string, nullable | Yes | |
Lines[].ExpiryDate |
string (date), nullable | Yes | |
Lines[].Serials |
array of strings | Yes | |
Lines[].Condition |
string, one of Good, Damaged |
Yes | |
Lines[].ReasonCode |
string, one of Overage, UnexpectedProduct, Damaged, null, nullable |
Yes | |
Asn |
object | Yes | An ASN with its lines and received totals (base units). |
Asn.AsnId |
string (uuid) | Yes | |
Asn.FacilityId |
string (uuid) | Yes | |
Asn.AsnNumber |
string | Yes | |
Asn.PurchaseOrderId |
string (uuid), nullable | Yes | |
Asn.PurchaseOrderNumber |
string, nullable | Yes | |
Asn.SupplierName |
string, nullable | Yes | |
Asn.Carrier |
string, nullable | Yes | |
Asn.ExpectedArrival |
string (date-time), nullable | Yes | |
Asn.DockLocationId |
string (uuid), nullable | Yes | |
Asn.Status |
string, one of Open, Receiving, Closed, Cancelled |
Yes | |
Asn.Lines |
array of objects | Yes | |
Asn.Lines[].LineId |
string (uuid) | Yes | |
Asn.Lines[].LineNumber |
integer | Yes | |
Asn.Lines[].ProductId |
string (uuid) | Yes | |
Asn.Lines[].Sku |
string | Yes | |
Asn.Lines[].Quantity |
integer | Yes | As entered, in UnitOfMeasureCode (0 for an unplanned line). |
Asn.Lines[].UnitOfMeasureCode |
string | Yes | |
Asn.Lines[].ExpectedQuantity |
integer | Yes | |
Asn.Lines[].ReceivedQuantity |
integer | Yes | Posted, damaged included. |
Asn.Lines[].DamagedQuantity |
integer | Yes | |
Asn.Lines[].LotNumber |
string, nullable | Yes | |
Asn.Lines[].ExpiryDate |
string (date), nullable | Yes | |
Asn.Lines[].PurchaseOrderLineId |
string (uuid), nullable | Yes | |
Asn.Lines[].Unplanned |
boolean | Yes | Added by receiving a product the ASN did not list. |
Asn.CreatedAt |
string (date-time) | Yes | |
Asn.UpdatedAt |
string (date-time) | Yes | |
CreatedAt |
string (date-time) | Yes | |
PostedAt |
string (date-time) | Yes | The same as UpdatedAt. |
UpdatedAt |
string (date-time) | Yes |
PutawayCompleted
Section titled “PutawayCompleted”Type: jtWMS.Inbound.Events.V1.PutawayCompleted
Published by the Inbound service when Inventory has moved a license plate to the location its putaway task was confirmed at. Carries the whole task.
Payload: A putaway task completed (Status Completed) once Inventory moved its license plate.
| Property | Type | Required | Description |
|---|---|---|---|
PutawayTaskId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
LpnId |
string (uuid) | Yes | |
LpnCode |
string | Yes | |
ReceiptId |
string (uuid) | Yes | |
FromLocationId |
string (uuid) | Yes | |
SuggestedLocationId |
string (uuid) | Yes | |
LocationId |
string (uuid) | Yes | Where it was put away. |
LocationCode |
string | Yes | |
OverrideReason |
string, one of LocationFull, LocationDamaged, Other, null, nullable |
Yes | Why it went somewhere other than the suggested location; null when it did not. |
InventoryTransactionId |
string (uuid) | Yes | |
Status |
string, one of Completed |
Yes | |
CreatedAt |
string (date-time) | Yes | |
CompletedAt |
string (date-time) | Yes | The same as UpdatedAt. |
UpdatedAt |
string (date-time) | Yes |