Outbound events
These are the outbound 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.
OrderCreated
Section titled “OrderCreated”Type: jtWMS.Outbound.Events.V1.OrderCreated
Published when an order is created through order intake. Carries the full order.
Payload: The new order (Status New).
| Property | Type | Required | Description |
|---|---|---|---|
OrderId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | The caller’s order number, unique in the facility. Min length 1. Max length 50. |
CustomerReference |
string, nullable | Yes | Max length 100. |
Priority |
integer | Yes | 1 is the most urgent. Minimum 1. Maximum 9. |
RequestedShipDate |
string (date), nullable | Yes | |
ShipTo |
object | Yes | Where an order ships to. |
ShipTo.Name |
string | Yes | Min length 1. Max length 100. |
ShipTo.Company |
string, nullable | Yes | Max length 100. |
ShipTo.Line1 |
string | Yes | Min length 1. Max length 100. |
ShipTo.Line2 |
string, nullable | Yes | Max length 100. |
ShipTo.City |
string | Yes | Min length 1. Max length 100. |
ShipTo.Region |
string, nullable | Yes | State, province or county. Max length 100. |
ShipTo.PostalCode |
string, nullable | Yes | Max length 20. |
ShipTo.CountryCode |
string | Yes | ISO 3166-1 alpha-2. Pattern ^[A-Z]{2}$. |
ShipTo.Phone |
string, nullable | Yes | Max length 30. |
ShipTo.Email |
string, nullable | Yes | Max length 254. |
CarrierCode |
string, nullable | Yes | The carrier the customer asked for; null to let shipping choose. Max length 50. |
ServiceLevel |
string, nullable | Yes | The carrier service asked for (e.g. Ground); null to let shipping choose. Max length 50. |
Status |
string, one of New, Waved, Allocating, Allocated, AllocationException, Picking, Picked, Packed, Shipped, Cancelled |
Yes | |
WaveId |
string (uuid), nullable | Yes | The live wave the order is in; null when in none. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | When it last changed; the event’s time. |
Lines |
array of objects | Yes | One order line. Quantity is in the line’s unit of measure; every other quantity is whole base units. |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | Minimum 1. |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | Minimum 1. |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].BaseQuantity |
integer | Yes | Quantity in base units. Minimum 1. |
Lines[].LotNumber |
string, nullable | Yes | The lot the line must ship from; null for any lot. Max length 64. |
Lines[].AllocatedQuantity |
integer | Yes | Minimum 0. |
Lines[].PickedQuantity |
integer | Yes | Minimum 0. |
Lines[].PackedQuantity |
integer | Yes | Minimum 0. |
Lines[].ShippedQuantity |
integer | Yes | Minimum 0. |
Lines[].AllocationStatus |
string, one of NotRequested, Requested, Allocated, Rejected, Released, Issued |
Yes | Where the line’s Inventory allocation stands. |
Lines[].AllocationErrorCode |
string, nullable | Yes | Inventory’s errorCode when the allocation was refused (Rejected); else null. |
OrderStatusChanged
Section titled “OrderStatusChanged”Type: jtWMS.Outbound.Events.V1.OrderStatusChanged
Published when an order’s status changes, for every change without an event of its own. Carries the full order with the previous and new status.
Payload: The order after the change, with the previous and new status.
| Property | Type | Required | Description |
|---|---|---|---|
OrderId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | The caller’s order number, unique in the facility. Min length 1. Max length 50. |
CustomerReference |
string, nullable | Yes | Max length 100. |
Priority |
integer | Yes | 1 is the most urgent. Minimum 1. Maximum 9. |
RequestedShipDate |
string (date), nullable | Yes | |
ShipTo |
object | Yes | Where an order ships to. |
ShipTo.Name |
string | Yes | Min length 1. Max length 100. |
ShipTo.Company |
string, nullable | Yes | Max length 100. |
ShipTo.Line1 |
string | Yes | Min length 1. Max length 100. |
ShipTo.Line2 |
string, nullable | Yes | Max length 100. |
ShipTo.City |
string | Yes | Min length 1. Max length 100. |
ShipTo.Region |
string, nullable | Yes | State, province or county. Max length 100. |
ShipTo.PostalCode |
string, nullable | Yes | Max length 20. |
ShipTo.CountryCode |
string | Yes | ISO 3166-1 alpha-2. Pattern ^[A-Z]{2}$. |
ShipTo.Phone |
string, nullable | Yes | Max length 30. |
ShipTo.Email |
string, nullable | Yes | Max length 254. |
CarrierCode |
string, nullable | Yes | The carrier the customer asked for; null to let shipping choose. Max length 50. |
ServiceLevel |
string, nullable | Yes | The carrier service asked for (e.g. Ground); null to let shipping choose. Max length 50. |
Status |
string, one of New, Waved, Allocating, Allocated, AllocationException, Picking, Picked, Packed, Shipped, Cancelled |
Yes | |
WaveId |
string (uuid), nullable | Yes | The live wave the order is in; null when in none. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | When it last changed; the event’s time. |
Lines |
array of objects | Yes | One order line. Quantity is in the line’s unit of measure; every other quantity is whole base units. |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | Minimum 1. |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | Minimum 1. |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].BaseQuantity |
integer | Yes | Quantity in base units. Minimum 1. |
Lines[].LotNumber |
string, nullable | Yes | The lot the line must ship from; null for any lot. Max length 64. |
Lines[].AllocatedQuantity |
integer | Yes | Minimum 0. |
Lines[].PickedQuantity |
integer | Yes | Minimum 0. |
Lines[].PackedQuantity |
integer | Yes | Minimum 0. |
Lines[].ShippedQuantity |
integer | Yes | Minimum 0. |
Lines[].AllocationStatus |
string, one of NotRequested, Requested, Allocated, Rejected, Released, Issued |
Yes | Where the line’s Inventory allocation stands. |
Lines[].AllocationErrorCode |
string, nullable | Yes | Inventory’s errorCode when the allocation was refused (Rejected); else null. |
PreviousStatus |
string, one of New, Waved, Allocating, Allocated, AllocationException, Picking, Picked, Packed, Shipped, Cancelled |
Yes | |
NewStatus |
string, one of New, Waved, Allocating, Allocated, AllocationException, Picking, Picked, Packed, Shipped, Cancelled |
Yes |
WaveReleased
Section titled “WaveReleased”Type: jtWMS.Outbound.Events.V1.WaveReleased
Published when a released wave has heard back from Inventory for every order line. Carries the full wave and the pick tasks it generated.
Payload: The released wave, the status of each of its orders (Allocated or AllocationException), and every pick task generated, in pick sequence per order.
| Property | Type | Required | Description |
|---|---|---|---|
WaveId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
Number |
string | Yes | W-000001 and up, per facility. |
Status |
string, one of Planned, Releasing, Released, Completed, Cancelled |
Yes | |
TemplateId |
string (uuid), nullable | Yes | The wave template that selected its orders, if any. |
OrderIds |
array of strings (uuid) | Yes | |
ReleasedAt |
string (date-time), nullable | Yes | |
CompletedAt |
string (date-time), nullable | Yes | |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | |
Orders |
array of objects | Yes | |
Orders[].OrderId |
string (uuid) | Yes | |
Orders[].OrderNumber |
string | Yes | |
Orders[].Status |
string, one of Allocated, AllocationException |
Yes | |
PickTasks |
array of objects | Yes | One pick: take a quantity of one product from one location (the source position of one allocation line) into the order’s tote. Quantities are whole base units. |
PickTasks[].PickTaskId |
string (uuid) | Yes | |
PickTasks[].FacilityId |
string (uuid) | Yes | |
PickTasks[].WaveId |
string (uuid) | Yes | |
PickTasks[].OrderId |
string (uuid) | Yes | |
PickTasks[].OrderNumber |
string | Yes | |
PickTasks[].OrderLineId |
string (uuid) | Yes | |
PickTasks[].Sequence |
integer | Yes | The task’s place in its order’s pick path (location code order). Minimum 1. |
PickTasks[].LocationId |
string (uuid) | Yes | |
PickTasks[].LocationCode |
string | Yes | |
PickTasks[].ProductId |
string (uuid) | Yes | |
PickTasks[].Sku |
string | Yes | |
PickTasks[].LotNumber |
string, nullable | Yes | |
PickTasks[].LpnId |
string (uuid), nullable | Yes | The license plate the stock is on at the location, if any. |
PickTasks[].LpnCode |
string, nullable | Yes | |
PickTasks[].Quantity |
integer | Yes | The quantity to pick (the expected quantity). Minimum 1. |
PickTasks[].PickedQuantity |
integer | Yes | Minimum 0. |
PickTasks[].ShortQuantity |
integer | Yes | Quantity minus PickedQuantity once the task is Shorted; else 0. Minimum 0. |
PickTasks[].Status |
string, one of Open, Assigned, Completed, Shorted, Cancelled |
Yes | |
PickTasks[].AssignedToType |
string, one of User, ApiKey, nullable |
Yes | Who the task is assigned to, a user or an API key (a machine client); null while Open. |
PickTasks[].AssignedToId |
string (uuid), nullable | Yes | The user’s or API key’s id; null while Open. |
PickTasks[].AssignedWorkerRef |
string, nullable | Yes | The worker an API-key assignment acts for (an RF or voice integration’s operator); null for a user, or without one. Max length 64. |
PickTasks[].ToteCode |
string, nullable | Yes | The tote picked into; null until picked. |
PickTasks[].CompletedAt |
string (date-time), nullable | Yes | When it was Completed or Shorted. |
PickTasks[].CreatedAt |
string (date-time) | Yes | |
PickTasks[].UpdatedAt |
string (date-time) | Yes |
PickTaskCompleted
Section titled “PickTaskCompleted”Type: jtWMS.Outbound.Events.V1.PickTaskCompleted
Published when a pick task is Completed: confirmed in full by the worker and applied by Inventory. Carries the full pick task.
Payload: The completed pick task.
| Property | Type | Required | Description |
|---|---|---|---|
PickTaskId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
WaveId |
string (uuid) | Yes | |
OrderId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | |
OrderLineId |
string (uuid) | Yes | |
Sequence |
integer | Yes | The task’s place in its order’s pick path (location code order). Minimum 1. |
LocationId |
string (uuid) | Yes | |
LocationCode |
string | Yes | |
ProductId |
string (uuid) | Yes | |
Sku |
string | Yes | |
LotNumber |
string, nullable | Yes | |
LpnId |
string (uuid), nullable | Yes | The license plate the stock is on at the location, if any. |
LpnCode |
string, nullable | Yes | |
Quantity |
integer | Yes | The quantity to pick (the expected quantity). Minimum 1. |
PickedQuantity |
integer | Yes | Minimum 0. |
ShortQuantity |
integer | Yes | Quantity minus PickedQuantity once the task is Shorted; else 0. Minimum 0. |
Status |
string, one of Open, Assigned, Completed, Shorted, Cancelled |
Yes | |
AssignedToType |
string, one of User, ApiKey, nullable |
Yes | Who the task is assigned to, a user or an API key (a machine client); null while Open. |
AssignedToId |
string (uuid), nullable | Yes | The user’s or API key’s id; null while Open. |
AssignedWorkerRef |
string, nullable | Yes | The worker an API-key assignment acts for (an RF or voice integration’s operator); null for a user, or without one. Max length 64. |
ToteCode |
string, nullable | Yes | The tote picked into; null until picked. |
CompletedAt |
string (date-time), nullable | Yes | When it was Completed or Shorted. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes |
PickTaskShorted
Section titled “PickTaskShorted”Type: jtWMS.Outbound.Events.V1.PickTaskShorted
Published when a worker finds less at a location than the task asked for. Carries the full pick task with the expected, picked and short quantities.
Payload: The shorted pick task: Quantity is what the task expected at the location, PickedQuantity what the worker found and picked, ShortQuantity the difference.
| Property | Type | Required | Description |
|---|---|---|---|
PickTaskId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
WaveId |
string (uuid) | Yes | |
OrderId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | |
OrderLineId |
string (uuid) | Yes | |
Sequence |
integer | Yes | The task’s place in its order’s pick path (location code order). Minimum 1. |
LocationId |
string (uuid) | Yes | |
LocationCode |
string | Yes | |
ProductId |
string (uuid) | Yes | |
Sku |
string | Yes | |
LotNumber |
string, nullable | Yes | |
LpnId |
string (uuid), nullable | Yes | The license plate the stock is on at the location, if any. |
LpnCode |
string, nullable | Yes | |
Quantity |
integer | Yes | The quantity to pick (the expected quantity). Minimum 1. |
PickedQuantity |
integer | Yes | Minimum 0. |
ShortQuantity |
integer | Yes | Quantity minus PickedQuantity once the task is Shorted; else 0. Minimum 0. |
Status |
string, one of Open, Assigned, Completed, Shorted, Cancelled |
Yes | |
AssignedToType |
string, one of User, ApiKey, nullable |
Yes | Who the task is assigned to, a user or an API key (a machine client); null while Open. |
AssignedToId |
string (uuid), nullable | Yes | The user’s or API key’s id; null while Open. |
AssignedWorkerRef |
string, nullable | Yes | The worker an API-key assignment acts for (an RF or voice integration’s operator); null for a user, or without one. Max length 64. |
ToteCode |
string, nullable | Yes | The tote picked into; null until picked. |
CompletedAt |
string (date-time), nullable | Yes | When it was Completed or Shorted. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes |
OrderPicked
Section titled “OrderPicked”Type: jtWMS.Outbound.Events.V1.OrderPicked
Published when every pick task of an order is done and Inventory has confirmed its picks. Carries the full order and its totes.
Payload: The order (Status Picked), with what each line picked, and the totes holding it.
| Property | Type | Required | Description |
|---|---|---|---|
OrderId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | The caller’s order number, unique in the facility. Min length 1. Max length 50. |
CustomerReference |
string, nullable | Yes | Max length 100. |
Priority |
integer | Yes | 1 is the most urgent. Minimum 1. Maximum 9. |
RequestedShipDate |
string (date), nullable | Yes | |
ShipTo |
object | Yes | Where an order ships to. |
ShipTo.Name |
string | Yes | Min length 1. Max length 100. |
ShipTo.Company |
string, nullable | Yes | Max length 100. |
ShipTo.Line1 |
string | Yes | Min length 1. Max length 100. |
ShipTo.Line2 |
string, nullable | Yes | Max length 100. |
ShipTo.City |
string | Yes | Min length 1. Max length 100. |
ShipTo.Region |
string, nullable | Yes | State, province or county. Max length 100. |
ShipTo.PostalCode |
string, nullable | Yes | Max length 20. |
ShipTo.CountryCode |
string | Yes | ISO 3166-1 alpha-2. Pattern ^[A-Z]{2}$. |
ShipTo.Phone |
string, nullable | Yes | Max length 30. |
ShipTo.Email |
string, nullable | Yes | Max length 254. |
CarrierCode |
string, nullable | Yes | The carrier the customer asked for; null to let shipping choose. Max length 50. |
ServiceLevel |
string, nullable | Yes | The carrier service asked for (e.g. Ground); null to let shipping choose. Max length 50. |
Status |
string, one of New, Waved, Allocating, Allocated, AllocationException, Picking, Picked, Packed, Shipped, Cancelled |
Yes | |
WaveId |
string (uuid), nullable | Yes | The live wave the order is in; null when in none. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | When it last changed; the event’s time. |
Lines |
array of objects | Yes | One order line. Quantity is in the line’s unit of measure; every other quantity is whole base units. |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | Minimum 1. |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | Minimum 1. |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].BaseQuantity |
integer | Yes | Quantity in base units. Minimum 1. |
Lines[].LotNumber |
string, nullable | Yes | The lot the line must ship from; null for any lot. Max length 64. |
Lines[].AllocatedQuantity |
integer | Yes | Minimum 0. |
Lines[].PickedQuantity |
integer | Yes | Minimum 0. |
Lines[].PackedQuantity |
integer | Yes | Minimum 0. |
Lines[].ShippedQuantity |
integer | Yes | Minimum 0. |
Lines[].AllocationStatus |
string, one of NotRequested, Requested, Allocated, Rejected, Released, Issued |
Yes | Where the line’s Inventory allocation stands. |
Lines[].AllocationErrorCode |
string, nullable | Yes | Inventory’s errorCode when the allocation was refused (Rejected); else null. |
ToteCodes |
array of strings | Yes |
ContainerPacked
Section titled “ContainerPacked”Type: jtWMS.Outbound.Events.V1.ContainerPacked
Published when a shipping container is closed at a pack station. Carries the full container with its contents, weight and the order’s ship-to and carrier choice.
Payload: The closed container, with the order’s ship-to, carrier and service level, so it can be routed from pack to ship without reading the order.
| Property | Type | Required | Description |
|---|---|---|---|
ContainerId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
Code |
string | Yes | C-000001 and up, per facility; printed on the carton. |
OrderId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | |
CartonTypeId |
string (uuid) | Yes | |
CartonTypeCode |
string | Yes | |
Length |
number | Yes | |
Width |
number | Yes | |
Height |
number | Yes | |
LengthUnit |
string, one of Cm, Mm, M, In |
Yes | |
Weight |
number, nullable | Yes | The captured gross weight; null while Open. |
ExpectedWeight |
number, nullable | Yes | Product weights plus the carton’s tare, in WeightUnit; null when a product has no weight. |
WeightUnit |
string, one of Kg, G, Lb, Oz |
Yes | |
Status |
string, one of Open, Closed |
Yes | |
Items |
array of objects | Yes | |
Items[].ItemId |
string (uuid) | Yes | |
Items[].OrderLineId |
string (uuid) | Yes | |
Items[].ProductId |
string (uuid) | Yes | |
Items[].Sku |
string | Yes | |
Items[].LotNumber |
string, nullable | Yes | |
Items[].Quantity |
integer | Yes | Base units. Minimum 1. |
ClosedAt |
string (date-time), nullable | Yes | |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | |
ShipTo |
object | Yes | Where an order ships to. |
ShipTo.Name |
string | Yes | Min length 1. Max length 100. |
ShipTo.Company |
string, nullable | Yes | Max length 100. |
ShipTo.Line1 |
string | Yes | Min length 1. Max length 100. |
ShipTo.Line2 |
string, nullable | Yes | Max length 100. |
ShipTo.City |
string | Yes | Min length 1. Max length 100. |
ShipTo.Region |
string, nullable | Yes | State, province or county. Max length 100. |
ShipTo.PostalCode |
string, nullable | Yes | Max length 20. |
ShipTo.CountryCode |
string | Yes | ISO 3166-1 alpha-2. Pattern ^[A-Z]{2}$. |
ShipTo.Phone |
string, nullable | Yes | Max length 30. |
ShipTo.Email |
string, nullable | Yes | Max length 254. |
CarrierCode |
string, nullable | Yes | |
ServiceLevel |
string, nullable | Yes | |
OrderPriority |
integer | Yes | Minimum 1. Maximum 9. |
RequestedShipDate |
string (date), nullable | Yes | The order’s requested ship date, for lane and door cut-offs. |
OrderPacked
Section titled “OrderPacked”Type: jtWMS.Outbound.Events.V1.OrderPacked
Published when everything picked for an order is in closed containers. Carries the full order and its containers.
Payload: The order (Status Packed) and every one of its containers (all Closed).
| Property | Type | Required | Description |
|---|---|---|---|
OrderId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | The caller’s order number, unique in the facility. Min length 1. Max length 50. |
CustomerReference |
string, nullable | Yes | Max length 100. |
Priority |
integer | Yes | 1 is the most urgent. Minimum 1. Maximum 9. |
RequestedShipDate |
string (date), nullable | Yes | |
ShipTo |
object | Yes | Where an order ships to. |
ShipTo.Name |
string | Yes | Min length 1. Max length 100. |
ShipTo.Company |
string, nullable | Yes | Max length 100. |
ShipTo.Line1 |
string | Yes | Min length 1. Max length 100. |
ShipTo.Line2 |
string, nullable | Yes | Max length 100. |
ShipTo.City |
string | Yes | Min length 1. Max length 100. |
ShipTo.Region |
string, nullable | Yes | State, province or county. Max length 100. |
ShipTo.PostalCode |
string, nullable | Yes | Max length 20. |
ShipTo.CountryCode |
string | Yes | ISO 3166-1 alpha-2. Pattern ^[A-Z]{2}$. |
ShipTo.Phone |
string, nullable | Yes | Max length 30. |
ShipTo.Email |
string, nullable | Yes | Max length 254. |
CarrierCode |
string, nullable | Yes | The carrier the customer asked for; null to let shipping choose. Max length 50. |
ServiceLevel |
string, nullable | Yes | The carrier service asked for (e.g. Ground); null to let shipping choose. Max length 50. |
Status |
string, one of New, Waved, Allocating, Allocated, AllocationException, Picking, Picked, Packed, Shipped, Cancelled |
Yes | |
WaveId |
string (uuid), nullable | Yes | The live wave the order is in; null when in none. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | When it last changed; the event’s time. |
Lines |
array of objects | Yes | One order line. Quantity is in the line’s unit of measure; every other quantity is whole base units. |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | Minimum 1. |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | Minimum 1. |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].BaseQuantity |
integer | Yes | Quantity in base units. Minimum 1. |
Lines[].LotNumber |
string, nullable | Yes | The lot the line must ship from; null for any lot. Max length 64. |
Lines[].AllocatedQuantity |
integer | Yes | Minimum 0. |
Lines[].PickedQuantity |
integer | Yes | Minimum 0. |
Lines[].PackedQuantity |
integer | Yes | Minimum 0. |
Lines[].ShippedQuantity |
integer | Yes | Minimum 0. |
Lines[].AllocationStatus |
string, one of NotRequested, Requested, Allocated, Rejected, Released, Issued |
Yes | Where the line’s Inventory allocation stands. |
Lines[].AllocationErrorCode |
string, nullable | Yes | Inventory’s errorCode when the allocation was refused (Rejected); else null. |
Containers |
array of objects | Yes | A shipping container (carton) packed for one order. Becomes a parcel when shipped. |
Containers[].ContainerId |
string (uuid) | Yes | |
Containers[].FacilityId |
string (uuid) | Yes | |
Containers[].Code |
string | Yes | C-000001 and up, per facility; printed on the carton. |
Containers[].OrderId |
string (uuid) | Yes | |
Containers[].OrderNumber |
string | Yes | |
Containers[].CartonTypeId |
string (uuid) | Yes | |
Containers[].CartonTypeCode |
string | Yes | |
Containers[].Length |
number | Yes | |
Containers[].Width |
number | Yes | |
Containers[].Height |
number | Yes | |
Containers[].LengthUnit |
string, one of Cm, Mm, M, In |
Yes | |
Containers[].Weight |
number, nullable | Yes | The captured gross weight; null while Open. |
Containers[].ExpectedWeight |
number, nullable | Yes | Product weights plus the carton’s tare, in WeightUnit; null when a product has no weight. |
Containers[].WeightUnit |
string, one of Kg, G, Lb, Oz |
Yes | |
Containers[].Status |
string, one of Open, Closed |
Yes | |
Containers[].Items |
array of objects | Yes | |
Containers[].Items[].ItemId |
string (uuid) | Yes | |
Containers[].Items[].OrderLineId |
string (uuid) | Yes | |
Containers[].Items[].ProductId |
string (uuid) | Yes | |
Containers[].Items[].Sku |
string | Yes | |
Containers[].Items[].LotNumber |
string, nullable | Yes | |
Containers[].Items[].Quantity |
integer | Yes | Base units. Minimum 1. |
Containers[].ClosedAt |
string (date-time), nullable | Yes | |
Containers[].CreatedAt |
string (date-time) | Yes | |
Containers[].UpdatedAt |
string (date-time) | Yes |
ShipmentLabelPurchased
Section titled “ShipmentLabelPurchased”Type: jtWMS.Outbound.Events.V1.ShipmentLabelPurchased
Published when carrier labels are bought for a shipment. Carries the full shipment with each parcel’s tracking number.
Payload: The shipment (Status Labelled) with every parcel’s tracking number.
| Property | Type | Required | Description |
|---|---|---|---|
ShipmentId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
OrderId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | |
CarrierAccountId |
string (uuid) | Yes | |
Provider |
string, one of Simulated, EasyPost |
Yes | |
Carrier |
string, nullable | Yes | The carrier of the purchased rate (e.g. USPS, UPS); null until purchased. |
Service |
string, nullable | Yes | The service of the purchased rate; null until purchased. |
RateAmount |
number, nullable | Yes | |
RateCurrency |
string, nullable | Yes | Pattern ^[A-Z]{3}$. |
Status |
string, one of Rated, Labelled, Shipped |
Yes | |
Parcels |
array of objects | Yes | One labelled parcel of a shipment: one container. |
Parcels[].ParcelId |
string (uuid) | Yes | |
Parcels[].ContainerId |
string (uuid) | Yes | |
Parcels[].ContainerCode |
string | Yes | |
Parcels[].TrackingNumber |
string, nullable | Yes | Null until the label is purchased. |
Parcels[].Weight |
number | Yes | |
Parcels[].WeightUnit |
string, one of Kg, G, Lb, Oz |
Yes | |
LoadReference |
string, nullable | Yes | The dock load or trailer that carried it; null until shipped, or when shipped by hand without one. Max length 100. |
LabelledAt |
string (date-time), nullable | Yes | |
ShippedAt |
string (date-time), nullable | Yes | |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes |
OrderShipped
Section titled “OrderShipped”Type: jtWMS.Outbound.Events.V1.OrderShipped
Published when an order is shipped. Carries the full order and its shipment.
Payload: The order (Status Shipped) and its shipment (Status Shipped).
| Property | Type | Required | Description |
|---|---|---|---|
OrderId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
OrderNumber |
string | Yes | The caller’s order number, unique in the facility. Min length 1. Max length 50. |
CustomerReference |
string, nullable | Yes | Max length 100. |
Priority |
integer | Yes | 1 is the most urgent. Minimum 1. Maximum 9. |
RequestedShipDate |
string (date), nullable | Yes | |
ShipTo |
object | Yes | Where an order ships to. |
ShipTo.Name |
string | Yes | Min length 1. Max length 100. |
ShipTo.Company |
string, nullable | Yes | Max length 100. |
ShipTo.Line1 |
string | Yes | Min length 1. Max length 100. |
ShipTo.Line2 |
string, nullable | Yes | Max length 100. |
ShipTo.City |
string | Yes | Min length 1. Max length 100. |
ShipTo.Region |
string, nullable | Yes | State, province or county. Max length 100. |
ShipTo.PostalCode |
string, nullable | Yes | Max length 20. |
ShipTo.CountryCode |
string | Yes | ISO 3166-1 alpha-2. Pattern ^[A-Z]{2}$. |
ShipTo.Phone |
string, nullable | Yes | Max length 30. |
ShipTo.Email |
string, nullable | Yes | Max length 254. |
CarrierCode |
string, nullable | Yes | The carrier the customer asked for; null to let shipping choose. Max length 50. |
ServiceLevel |
string, nullable | Yes | The carrier service asked for (e.g. Ground); null to let shipping choose. Max length 50. |
Status |
string, one of New, Waved, Allocating, Allocated, AllocationException, Picking, Picked, Packed, Shipped, Cancelled |
Yes | |
WaveId |
string (uuid), nullable | Yes | The live wave the order is in; null when in none. |
CreatedAt |
string (date-time) | Yes | |
UpdatedAt |
string (date-time) | Yes | When it last changed; the event’s time. |
Lines |
array of objects | Yes | One order line. Quantity is in the line’s unit of measure; every other quantity is whole base units. |
Lines[].LineId |
string (uuid) | Yes | |
Lines[].LineNumber |
integer | Yes | Minimum 1. |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | Minimum 1. |
Lines[].UnitOfMeasureCode |
string | Yes | |
Lines[].BaseQuantity |
integer | Yes | Quantity in base units. Minimum 1. |
Lines[].LotNumber |
string, nullable | Yes | The lot the line must ship from; null for any lot. Max length 64. |
Lines[].AllocatedQuantity |
integer | Yes | Minimum 0. |
Lines[].PickedQuantity |
integer | Yes | Minimum 0. |
Lines[].PackedQuantity |
integer | Yes | Minimum 0. |
Lines[].ShippedQuantity |
integer | Yes | Minimum 0. |
Lines[].AllocationStatus |
string, one of NotRequested, Requested, Allocated, Rejected, Released, Issued |
Yes | Where the line’s Inventory allocation stands. |
Lines[].AllocationErrorCode |
string, nullable | Yes | Inventory’s errorCode when the allocation was refused (Rejected); else null. |
Shipment |
object | Yes | The shipment of one packed order, through one carrier account. |
Shipment.ShipmentId |
string (uuid) | Yes | |
Shipment.FacilityId |
string (uuid) | Yes | |
Shipment.OrderId |
string (uuid) | Yes | |
Shipment.OrderNumber |
string | Yes | |
Shipment.CarrierAccountId |
string (uuid) | Yes | |
Shipment.Provider |
string, one of Simulated, EasyPost |
Yes | |
Shipment.Carrier |
string, nullable | Yes | The carrier of the purchased rate (e.g. USPS, UPS); null until purchased. |
Shipment.Service |
string, nullable | Yes | The service of the purchased rate; null until purchased. |
Shipment.RateAmount |
number, nullable | Yes | |
Shipment.RateCurrency |
string, nullable | Yes | Pattern ^[A-Z]{3}$. |
Shipment.Status |
string, one of Rated, Labelled, Shipped |
Yes | |
Shipment.Parcels |
array of objects | Yes | One labelled parcel of a shipment: one container. |
Shipment.Parcels[].ParcelId |
string (uuid) | Yes | |
Shipment.Parcels[].ContainerId |
string (uuid) | Yes | |
Shipment.Parcels[].ContainerCode |
string | Yes | |
Shipment.Parcels[].TrackingNumber |
string, nullable | Yes | Null until the label is purchased. |
Shipment.Parcels[].Weight |
number | Yes | |
Shipment.Parcels[].WeightUnit |
string, one of Kg, G, Lb, Oz |
Yes | |
Shipment.LoadReference |
string, nullable | Yes | The dock load or trailer that carried it; null until shipped, or when shipped by hand without one. Max length 100. |
Shipment.LabelledAt |
string (date-time), nullable | Yes | |
Shipment.ShippedAt |
string (date-time), nullable | Yes | |
Shipment.CreatedAt |
string (date-time) | Yes | |
Shipment.UpdatedAt |
string (date-time) | Yes |
BatchToteCompleted
Section titled “BatchToteCompleted”Type: jtWMS.Outbound.Events.V1.BatchToteCompleted
Published when a batch tote is closed and sent to its put wall. Carries the full tote: wave, destination wall, orders and lines.
Payload: The tote (Status Completed), on its way to its put wall.
| Property | Type | Required | Description |
|---|---|---|---|
ToteCode |
string | Yes | |
FacilityId |
string (uuid) | Yes | |
WaveId |
string (uuid) | Yes | The batch (a wave in Batch picking mode). |
WaveNumber |
string | Yes | |
PutWallId |
string (uuid) | Yes | |
PutWallCode |
string | Yes | The destination wall’s code; the routing key. |
Status |
string, one of Completed, Inducted |
Yes | |
OrderIds |
array of strings (uuid) | Yes | |
Lines |
array of objects | Yes | |
Lines[].OrderId |
string (uuid) | Yes | |
Lines[].OrderLineId |
string (uuid) | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | Base units in the tote for this order line. Minimum 1. |
CompletedAt |
string (date-time) | Yes | |
InductedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes | The tote row’s stored updatedAt; the event’s time. |
BatchToteInducted
Section titled “BatchToteInducted”Type: jtWMS.Outbound.Events.V1.BatchToteInducted
Published when a batch tote is inducted at its put wall. Carries the full tote.
Payload: The tote (Status Inducted) at its put wall.
| Property | Type | Required | Description |
|---|---|---|---|
ToteCode |
string | Yes | |
FacilityId |
string (uuid) | Yes | |
WaveId |
string (uuid) | Yes | The batch (a wave in Batch picking mode). |
WaveNumber |
string | Yes | |
PutWallId |
string (uuid) | Yes | |
PutWallCode |
string | Yes | The destination wall’s code; the routing key. |
Status |
string, one of Completed, Inducted |
Yes | |
OrderIds |
array of strings (uuid) | Yes | |
Lines |
array of objects | Yes | |
Lines[].OrderId |
string (uuid) | Yes | |
Lines[].OrderLineId |
string (uuid) | Yes | |
Lines[].ProductId |
string (uuid) | Yes | |
Lines[].Sku |
string | Yes | |
Lines[].Quantity |
integer | Yes | Base units in the tote for this order line. Minimum 1. |
CompletedAt |
string (date-time) | Yes | |
InductedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes | The tote row’s stored updatedAt; the event’s time. |
PutWallCubbyStatusChanged
Section titled “PutWallCubbyStatusChanged”Type: jtWMS.Outbound.Events.V1.PutWallCubbyStatusChanged
Published when a put wall cubby is assigned an order, becomes ready for pack, or is freed. Carries the full cubby and its wall.
Payload: The cubby after the change, its wall, and the order it holds (or, when Free, the order it held until now).
| Property | Type | Required | Description |
|---|---|---|---|
FacilityId |
string (uuid) | Yes | |
PutWallId |
string (uuid) | Yes | |
PutWallCode |
string | Yes | |
CubbyId |
string (uuid) | Yes | |
CubbyCode |
string | Yes | Row letter and two-digit column, such as A01. |
LpnCode |
string | Yes | The Inventory tote holding the cubby’s stock, {wall code}-{cubby code}. |
Row |
integer | Yes | Minimum 1. Maximum 26. |
Column |
integer | Yes | Minimum 1. Maximum 99. |
Enabled |
boolean | Yes | A disabled cubby takes no new order. |
Status |
string, one of Free, Assigned, ReadyForPack |
Yes | |
PreviousStatus |
string, one of Free, Assigned, ReadyForPack |
Yes | |
OrderId |
string (uuid), nullable | Yes | |
OrderNumber |
string, nullable | Yes | |
WaveId |
string (uuid), nullable | Yes | |
AssignedAt |
string (date-time), nullable | Yes | |
ReadyForPackAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes | The cubby row’s stored updatedAt; the event’s time. |
OutboundCommandCompleted
Section titled “OutboundCommandCompleted”Type: jtWMS.Outbound.Events.V1.OutboundCommandCompleted
Published when the Outbound service carries out a command. A redelivered command changes nothing and publishes it again with the same values.
Payload: A command the Outbound service carried out.
| Property | Type | Required | Description |
|---|---|---|---|
CommandId |
string (uuid) | Yes | The command’s id, which the sender chose and Outbound deduplicates on. |
CommandType |
string | Yes | The command’s canonical name, such as jtWMS.Outbound.Commands.V1.ShipShipment. |
FacilityId |
string (uuid) | Yes | |
ShipmentId |
string (uuid), nullable | Yes | |
Changed |
boolean | Yes | False when the command found its work already done (an already Shipped shipment). |
CompletedAt |
string (date-time) | Yes |
OutboundCommandRejected
Section titled “OutboundCommandRejected”Type: jtWMS.Outbound.Events.V1.OutboundCommandRejected
Published when the Outbound service refuses a command by a business rule: nothing changed. A redelivered command publishes it again with the same values.
Payload: A command the Outbound service refused by a business rule; nothing changed.
| Property | Type | Required | Description |
|---|---|---|---|
CommandId |
string (uuid) | Yes | The command’s id, which the sender chose and Outbound deduplicates on. |
CommandType |
string | Yes | The command’s canonical name, such as jtWMS.Outbound.Commands.V1.ShipShipment. |
FacilityId |
string (uuid) | Yes | |
ShipmentId |
string (uuid), nullable | Yes | |
ErrorCode |
string | Yes | shipment_not_found, shipment_not_labelled, order_not_packed or invalid_command. |
Detail |
string, nullable | Yes | |
RejectedAt |
string (date-time) | Yes |