A Shipment Assign Notification (which may sometimes be referred to as a “Ready Shipment Notification”) is sent when a shipment is assigned to a store, which places the order into “READY” status and thus triggers the notification.
Notification Parameters
The fields returned in the Shipment Assign Notification are described in the below table.
| Field | Type | Description |
| eventTypeID | string | Always shown as ’ready_shipment’. |
| orderID | integer | The identifier of the order affected by the shipment assign. |
| shipmentID | integer | The identifier of the shipment affected by the shipment assign. |
| externalOrderID | string | Client-generated unique identifier for the Order sent to Kibo. |
| parentOrderID | integer | For a transfer order, this is the order identifier of the parent In-Store Pickup order. |
| manufacturerID | integer | A unique identifier for a manufacturer. |
| retailerID | integer | A unique identifier for a retailer. |
| locationID | integer | A unique identifier for a location. |
| externalStoreID | string | The fulfiller’s identifier for a location. |
| shipToLocationID | integer | For a transfer order, the unique identifier for the destination location. |
| shipToExternalStoreID | string | For a transfer order, the fulfiller’s identifier for the destination location. |
| shipType | string | The speed of delivery. Ex: REGULAR, EXPRESS |
| shipperName | string | The name of the location. |
| shipmentStateType | string | Shipment order type. STH, ISPU, or STS |
| isTestOrder | boolean | Test order flag. |
| isInventory | boolean | Inventory order flag. |
| data | object | Empty |
This example demonstrates how parameters might be defined for shipment assignment.
{
"eventTypeID":"ready_shipment",
"orderID":"65656565",
"shipmentID":"111222333",
"externalOrderID":"DeveloperTestOrder-822",
"manufacturerID":"11111",
"retailerID":"9999",
"locationID":"15",
"externalStoreID":"10101",
"shipType":"REGULAR",
"shipperName":"Tester",
"shipmentStateType":"STH",
"isTestOrder":true,
"isInventory":true,
"data":null,
"scope":{
"mfgID":"11111",
"catalogID":"0",
"fulfillerID":"22222"
}
}