Putaway events
Putaway events are generated as part of the Putaway APIs whenever you create or complete a putaway task in the Store Inventory Management microservice.
The following examples illustrate the putaway events in Sterling Store Engagement.
Putaway Task Created event
When you create putaway tasks in Store Inventory
Management, Sterling Store Engagement triggers the
Putaway Task Created event. The code for this event is putawayTasksCreated.
The following sample JSON illustrates the published event. The application encodes and adds the
event data to messages[].data JSON path.
{
"messages": [
{
"data": {
"receiptNo": "3cacb233-de1b-47f9-97a6-4486488f3205",
"storeId": "BOSTON-1",
"performedByUserId": "John",
"orderNo": "10001",
"shipmentNo": "10036633733",
"receivingDock": "dock101",
"receivedProducts": [
{
"receiptLineNo": "RL-12A345-SD873-H7893-W3456-2",
"shipmentLineNo": "10036633732",
"containerNo": "10036633234",
"productId": "SMART-TABLET",
"unitOfMeasure": "EACH",
"inventoryStatus": "GOOD",
"productClass": "NEW",
"segmentType": "CHANNEL",
"segment": "PFS",
"batchNo": "Batch1",
"lotNo": "Lot1234",
"tagNo": "tag101",
"manufacturedDate": "01/01/2018",
"serials": [
"SR1",
"SR2",
"SR3",
"SR4",
"SR5"
],
"quantity": 5
}
],
"putawayTasks": [
{
"taskId": "500345rt-de1b-47f9-97a6-4486488f3105",
"receiptLineNo": "RL-12A345-SD873-H7893-W3456-2",
"containerNo": "10036633234",
"productId": "SMART-TABLET",
"unitOfMeasure": "EACH",
"inventoryStatus": "GOOD",
"productClass": "NEW",
"segmentType": "CHANNEL",
"segment": "PFS",
"batchNo": "Batch1",
"lotNo": "Lot1234",
"tagNo": "tag101",
"manufacturedDate": "01/01/2018",
"status": "COMLETED",
"requestedQuantity": 5,
"shortageQuantity": 0,
"completedQuantity": 0,
"sourceLocationId": "dock101",
"targetLocationId": "STORE_BACK-1",
"createdTimestamp": "2019-06-20T08:27:13.038933300Z",
"sourceLocationSequence": 0,
"requestedSerials": [
"SR1",
"SR2",
"SR3",
"SR4",
"SR5"
],
"completedSerials": []
}
]
},
"attributes": {
"eventCode": "putawayTasksCreated",
"timestamp": "2021-11-18T10:34:49.997304Z",
"messageId": "100345rt-de1b-47f9-97a6-4486488f3204"
}
}
]
}The following sample illustrates the JSON schema specification that defines the structure of JSON
data published to the putawayTasksCreated event.
{
"title": "Putaway Tasks Created event message",
"type": "object",
"description": "Indicates the message payload published for Putaway Tasks Created event.",
"properties": {
"messages": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "Indicates the event data published in the message.",
"properties": {
"data": {
"type": "object",
"description": "",
"properties": {
"receiptNo": {
"type": "string",
"description": "Identifier of the receipt for which the request is created"
},
"storeId": {
"type": "string",
"description": "The store identifier"
},
"performedByUserId": {
"type": "string",
"description": "User Id who has performed the create putaway task operation."
},
"orderNo": {
"type": "string",
"description": "Identifier of the order for which the request is created"
},
"shipmentNo": {
"type": "string",
"description": "Identifier of the shipment for which the request is created"
},
"receivingDock": {
"type": "string",
"description": "The location identifier for receiving dock"
},
"receivedProducts": {
"type": "array",
"description": "Received product details list",
"items": {
"type": "object",
"description": "Received product details list",
"properties": {
"receiptLineNo": {
"type": "string",
"description": "The receipt line Identifier"
},
"shipmentLineNo": {
"type": "string",
"description": "The shipment line Identifier"
},
"containerNo": {
"type": "string",
"description": "The container Identifier"
},
"productId": {
"type": "string",
"description": "The product identifier"
},
"unitOfMeasure": {
"type": "string",
"description": "The unit of measure for the product"
},
"productClass": {
"type": "string",
"description": "The product class of the product"
},
"inventoryStatus": {
"type": "string",
"description": "Indicates the inventory status"
},
"segmentType": {
"type": "string",
"description": "Indicates the segment type"
},
"segment": {
"type": "string",
"description": "Indicates the segment"
},
"tagNo": {
"type": "string",
"description": "Indicates the tag number"
},
"batchNo": {
"type": "string",
"description": "Indicates the batch number"
},
"lotNo": {
"type": "string",
"description": "Indicates the lot number"
},
"manufacturedDate": {
"type": "string",
"description": "Indicates the manufacturing date of the product"
},
"serials": {
"type": "array",
"description": "Indicates list of serial numbers to be received",
"items": {
"type": "string"
}
},
"quantity": {
"type": "number",
"format": "double",
"description": "Indicates the quantity requested"
}
}
}
},
"putawayTasks": {
"type": "array",
"description": "List of Putaway Tasks",
"items": {
"type": "object",
"description": "List of Putaway Tasks",
"properties": {
"taskId": {
"type": "string",
"format": "uuid",
"description": "The putaway task identifier"
},
"receiptLineNo": {
"type": "string",
"description": "The receipt line Identifier"
},
"containerNo": {
"type": "string",
"description": "The container Identifier"
},
"productId": {
"type": "string",
"description": "The product identifier"
},
"unitOfMeasure": {
"type": "string",
"description": "The unit of measure for the product"
},
"productClass": {
"type": "string",
"description": "The product class of the product"
},
"inventoryStatus": {
"type": "string",
"description": "Indicates the inventory status"
},
"segmentType": {
"type": "string",
"description": "Indicates the segment type"
},
"segment": {
"type": "string",
"description": "Indicates the segment"
},
"tagNo": {
"type": "string",
"description": "Indicates the tag number"
},
"batchNo": {
"type": "string",
"description": "Indicates the batch number"
},
"lotNo": {
"type": "string",
"description": "Indicates the lot number"
},
"manufacturedDate": {
"type": "string",
"description": "Indicates the manufacturing date of the product"
},
"status": {
"type": "string",
"description": "Indicates the status of the putaway task"
},
"requestedQuantity": {
"type": "number",
"format": "double",
"description": "Indicates the quantity requested"
},
"shortageQuantity": {
"type": "number",
"format": "double",
"description": "Indicates the shortage quantity"
},
"completedQuantity": {
"type": "number",
"format": "double",
"description": "Indicates the completed quantity"
},
"sourceLocationId": {
"type": "string",
"description": "Indicates the source location identifier"
},
"targetLocationId": {
"type": "string",
"description": "Indicates the target location identifier"
},
"createdTimestamp": {
"type": "string",
"description": "Indicates time when the task got created"
},
"sourceLocationSequence": {
"type": "integer",
"description": "Indicates the sequence of source location."
},
"requestedSerials": {
"type": "array",
"description": "Indicates list of serial numbers requested to receive",
"items": {
"type": "string"
}
},
"completedSerials": {
"type": "array",
"description": "Indicates list of serial numbers receiving completed",
"items": {
"type": "string"
}
}
}
}
}
}
},
"attributes": {
"type": "object",
"description": "",
"properties": {
"eventCode": {
"type": "string",
"description": "Indicates the event code of the message."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Indicates the time when the message was triggered."
},
"messageId": {
"type": "string",
"format": "uuid",
"description": "Indicates the message identifier."
}
}
}
}
}
}
}
}Putaway Task Completed event
When you complete putaway tasks in Store Inventory
Management, Sterling Store Engagement triggers
the Putaway Task Completed event. The code for this event is
putawayTaskCompleted.
The following sample JSON illustrates the published event. Sterling Store Engagement encodes and
adds the event data to messages[].data JSON path.
{
"messages": [
{
"data": {
"receiptNo": "3cacb233-de1b-47f9-97a6-4486488f3205",
"orderNo": "10001",
"shipmentNo": "10036633733",
"storeId": "BOSTON-1",
"performedByUserId": "John",
"taskId": "500345rt-de1b-47f9-97a6-4486488f3105",
"receiptLineNo": "RL-12A345-SD873-H7893-W3456-2",
"containerNo": "10036633234",
"productId": "SMART-TABLET",
"unitOfMeasure": "EACH",
"inventoryStatus": "BAD",
"inventoryStatusOnPutaway": "SELLABLE",
"productClass": "NEW",
"segmentType": "CHANNEL",
"segment": "PFS",
"batchNo": "Batch1",
"lotNo": "Lot1234",
"tagNo": "tag101",
"manufacturedDate": "01/01/2018",
"status": "COMLETED",
"requestedQuantity": 5,
"shortageQuantity": 0,
"completedQuantity": 5,
"sourceLocationId": "dock101",
"targetLocationId": "STORE_BACK-1",
"sourceLocationSequence": 0,
"requestedSerials": [
"SR1",
"SR2",
"SR3",
"SR4",
"SR5"
],
"completedSerials": [
"SR1",
"SR2",
"SR3",
"SR4",
"SR5"
],
"assignedToUserId": "user1"
},
"attributes": {
"eventCode": "putawayTaskCompleted",
"timestamp": "2021-11-18T10:34:49.997304Z",
"messageId": "890543rt-de1b-47f9-97a6-4486488e9081"
}
}
]
}The following sample illustrates the JSON schema specification that defines the structure of JSON
data published to the putawayTaskCompleted event.
{
"title": "Putaway Task Complete event message",
"type": "object",
"description": "Indicates the message payload published for Putaway Task Completed event.",
"properties": {
"messages": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "Indicates the event data published in the message.",
"properties": {
"data": {
"type": "object",
"description": "",
"properties": {
"receiptNo": {
"type": "string",
"description": "Identifier of the receipt for which the request is created"
},
"taskId": {
"type": "string",
"format": "uuid",
"description": "The putaway task identifier"
},
"performedByUserId": {
"type": "string",
"description": "User Id who has performed the complete putaway task operation."
},
"receiptLineNo": {
"type": "string",
"description": "The receipt line Identifier"
},
"containerNo": {
"type": "string",
"description": "The container Identifier"
},
"productId": {
"type": "string",
"description": "The product identifier"
},
"unitOfMeasure": {
"type": "string",
"description": "The unit of measure for the product"
},
"productClass": {
"type": "string",
"description": "The product class of the product"
},
"inventoryStatus": {
"type": "string",
"description": "Indicates the inventory status"
},
"segmentType": {
"type": "string",
"description": "Indicates the segment type"
},
"segment": {
"type": "string",
"description": "Indicates the segment"
},
"tagNo": {
"type": "string",
"description": "Indicates the tag number"
},
"batchNo": {
"type": "string",
"description": "Indicates the batch number"
},
"lotNo": {
"type": "string",
"description": "Indicates the lot number"
},
"manufacturedDate": {
"type": "string",
"description": "Indicates the manufacturing date of the product"
},
"status": {
"type": "string",
"description": "Indicates the status of the putaway task"
},
"requestedQuantity": {
"type": "number",
"format": "double",
"description": "Indicates the quantity requested"
},
"shortageQuantity": {
"type": "number",
"format": "double",
"description": "Indicates the shortage quantity"
},
"completedQuantity": {
"type": "number",
"format": "double",
"description": "Indicates the completed quantity"
},
"sourceLocationId": {
"type": "string",
"description": "Indicates the source location identifier"
},
"targetLocationId": {
"type": "string",
"description": "Indicates the target location identifier"
},
"createdTimestamp": {
"type": "string",
"description": "Indicates time when the task got created"
},
"sourceLocationSequence": {
"type": "integer",
"description": "Indicates the sequence of source location."
},
"requestedSerials": {
"type": "array",
"description": "Indicates list of serial numbers requested to receive",
"items": {
"type": "string"
}
},
"completedSerials": {
"type": "array",
"description": "Indicates list of serial numbers receiving completed",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"type": "object",
"description": "",
"properties": {
"eventCode": {
"type": "string",
"description": "Indicates the event code of the message."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Indicates the time when the message was triggered."
},
"messageId": {
"type": "string",
"format": "uuid",
"description": "Indicates the message identifier."
}
}
}
}
}
}
}
}