/
Shipment Events

Shipment Events

Owned by Shubham Gupta (Unlicensed)
Last updated: May 12, 2022
5 min read

The Below Table explains the description of each Block present in Sequence Diagram

Component 

Infra Description

Building block Service

App Engine Service Name:
GCloud Project ID: esb-platform-prod (PROD)

esb-platform-staging (STAGING)
Repository Name:

Invoice Service 

App Engine Service Name: Invoice Service
GCloud Project ID: esb-integration-engine (PROD)

esb-integration-engine (STAGING)
Repository Name: esb-invoice-service

PubSub

Topic Name: nf_prod_ws_shipment_{{facility}}_createshipment_updated_v1
GCloud Project ID: esb-platform-prod (PROD)

esb-platform-staging (STAGING)

Mark Accepted

API to mark the given shipment accepted on WMS

Reject Order

API to reject the given shipment on WMS

Mark Picked

API to mark the given shipment picked on WMS

Mark Dispatched

API to mark the given shipment dispatched on WMS

  1. The Building Block service will publish the shipments events to the topic corresponding to the fulfilment channel of the shipment. for e.g., if FC is “gurgaonfc“ then the topic on which this event will be published is:
    Topic: nf_prod_ws_shipment_gurgaonfc_createshipment_updated_v1
    Topic name:

    nf_prod_ws_shipment_{{fc}}_createshipment_updated_v1

  2. The POST endpoint “shipment/event/listener“ will listen to the events from the topic and depending upon their “shipmentStatus“ perform the corresponding actions.
    2.1 Extract key “shipmentStatus“ from the event received.
    2.2. If “shipmentStatus” is equal to either “CREATED“, “CANCELLED“, ”PICKED” and “DISPATCHED“ then only proceed further else don’t perform any action.
    Event Received:

    { "resource": "ws_shipment_tcnsggn", "eventType": "PUT", "eventSubType": "createshipment_updated", "accountSlug": "tcnsggn", "slugType": "WORKSPACESLUG", "actor": "NA", "version": "v1", "previousData": { "createdAt": "Feb 13, 2022 3:21:13 PM", "isRecordEditable": false, "buildingBlock": "shipment", "record": { "channelOrderID": "ESBPB04404", "pickingPlannerStatus": "RUNNING", "shipmentCreatedAt": "Feb 13, 2022 3:21:09 PM", "itemsInShipment": 3.0, "customerOrderID": "WA1000824449", "salesChannel": "CH1491", "orderItems": [ "WA1000824449-2", "WA1000824449-1", "WA1000824449-3" ], "fulfillmentChannel": "UNICOMMERCE_TCNS_TGGN_1458", "orderCreatedinEshopbox": "Feb 13, 2022 3:21:09 PM", "salesChannelName": "WCUSTOM", "shipmentID": "ESBPB04404-1491-86", "traceabilityLevel": "Item level", "orderItemIds": [ "620921e93c369f6fee8fa16a", "620921e93c369f6fee8fa16b", "620921e93c369f6fee8fa16c" ], "paymentMethod": "Prepaid", "fulfillmentPriority": "Low", "orderCreatedAt": "Feb 13, 2022 9:37:08 AM", "remarks": "fulfillment_cancel", "expectedFulfillmentBy": "Feb 14, 2022 10:30:00 AM", "shipmentStatus": "CANCELLED", "Shipmentcreated at": "Feb 13, 2022 3:21:13 PM" }, "nextActions": [], "previousAction": "createShipment", "updatedAt": "Feb 13, 2022 3:22:02 PM", "id": "620921e93c369f6fee8fa169" }, "responseData": { "isRecordEditable": false, "record": { "channelOrderID": "ESBPB04404", "pickingPlannerStatus": "RUNNING", "shipmentCreatedAt": "Feb 13, 2022 3:21:09 PM", "itemsInShipment": 3.0, "customerOrderID": "WA1000824449", "salesChannel": "CH1491", "orderItems": [ { "_id": { "timestamp": 1.644765673E9, "counter": 9412970.0, "randomValue1": 3946143.0, "randomValue2": 28654.0 }, "createdAt": "Feb 13, 2022 3:21:13 PM", "isRecordEditable": false, "buildingBlock": "orderItems", "record": { "channelOrderID": "ESBPB04404", "quantity": 1.0, "orderItemID": "WA1000824449-2", "customerOrderID": "WA1000824449", "inventoryStatus": "Unfulfillable", "refOrderItemID": "WA1000824449-2", "ean": "8907819276768", "productImage": "https://buywclothes.com/promotions/SS20/Aurelia/Low_Res_Grey/20FEAS11189-601165/20FEAS11189-601165_1.JPG", "orderItemStatus": "CANCELLED", "shipmentID": "620921e93c369f6fee8fa169", "shipmentId": [ "ESBPB04404-1491-86", "ESBPB04404-1491-86" ], "traceabilityLevel": "Item level", "Orderitemcreated at": "Feb 13, 2022 3:21:13 PM", "esin": "8907819276768", "sku": "8907819276768", "orderCreatedAt": "Feb 13, 2022 12:00:00 AM", "productType": "Product" }, "nextActions": [], "previousAction": "createOrderItem", "updatedAt": "Feb 13, 2022 3:22:02 PM" }, { "_id": { "timestamp": 1.644765673E9, "counter": 9412971.0, "randomValue1": 3946143.0, "randomValue2": 28654.0 }, "createdAt": "Feb 13, 2022 3:21:13 PM", "isRecordEditable": false, "buildingBlock": "orderItems", "record": { "channelOrderID": "ESBPB04404", "quantity": 1.0, "orderItemID": "WA1000824449-1", "customerOrderID": "WA1000824449", "inventoryStatus": "Unfulfillable", "refOrderItemID": "WA1000824449-1", "ean": "8907819861537", "productImage": "https://buywclothes.com/promotions/SS20/Aurelia/Inward/20FED10283-501401_1.JPG", "orderItemStatus": "CANCELLED", "shipmentID": "620921e93c369f6fee8fa169", "shipmentId": [ "ESBPB04404-1491-86", "ESBPB04404-1491-86" ], "traceabilityLevel": "Item level", "Orderitemcreated at": "Feb 13, 2022 3:21:13 PM", "esin": "8907819861537", "sku": "8907819861537", "orderCreatedAt": "Feb 13, 2022 12:00:00 AM", "productType": "Product" }, "nextActions": [], "previousAction": "createOrderItem", "updatedAt": "Feb 13, 2022 3:22:02 PM" }, { "_id": { "timestamp": 1.644765673E9, "counter": 9412972.0, "randomValue1": 3946143.0, "randomValue2": 28654.0 }, "createdAt": "Feb 13, 2022 3:21:13 PM", "isRecordEditable": false, "buildingBlock": "orderItems", "record": { "channelOrderID": "ESBPB04404", "quantity": 1.0, "orderItemID": "WA1000824449-3", "customerOrderID": "WA1000824449", "inventoryStatus": "Unfulfillable", "refOrderItemID": "WA1000824449-3", "upc": "8907819953836", "ean": "8907819953836", "productImage": "https://buywclothes.com/promotions/MF20/Aurelia/Low_Res_Grey/20AUA11623-701228/20AUA11623-701228_1.JPG", "orderItemStatus": "CANCELLED", "shipmentID": "620921e93c369f6fee8fa169", "shipmentId": [ "ESBPB04404-1491-86", "ESBPB04404-1491-86" ], "traceabilityLevel": "Item level", "Orderitemcreated at": "Feb 13, 2022 3:21:13 PM", "esin": "362TD3GP17V", "sku": "8907819953836", "orderCreatedAt": "Feb 13, 2022 12:00:00 AM", "productType": "Product" }, "nextActions": [], "previousAction": "createOrderItem", "updatedAt": "Feb 13, 2022 3:22:02 PM" } ], "fulfillmentChannel": "UNICOMMERCE_TCNS_TGGN_1458", "orderCreatedinEshopbox": "Feb 13, 2022 3:21:09 PM", "salesChannelName": "WCUSTOM", "shipmentID": "ESBPB04404-1491-86", "traceabilityLevel": "Item level", "orderItemIds": [ { "createdAt": "Feb 13, 2022 3:21:13 PM", "isRecordEditable": false, "buildingBlock": "orderItems", "record": { "channelOrderID": "ESBPB04404", "quantity": 1.0, "orderItemID": "WA1000824449-2", "customerOrderID": "WA1000824449", "inventoryStatus": "Unfulfillable", "refOrderItemID": "WA1000824449-2", "ean": "8907819276768", "productImage": "https://buywclothes.com/promotions/SS20/Aurelia/Low_Res_Grey/20FEAS11189-601165/20FEAS11189-601165_1.JPG", "orderItemStatus": "CANCELLED", "shipmentID": "620921e93c369f6fee8fa169", "shipmentId": [ "ESBPB04404-1491-86", "ESBPB04404-1491-86" ], "traceabilityLevel": "Item level", "Orderitemcreated at": "Feb 13, 2022 3:21:13 PM", "esin": "8907819276768", "sku": "8907819276768", "orderCreatedAt": "Feb 13, 2022 12:00:00 AM", "productType": "Product" }, "nextActions": [], "previousAction": "createOrderItem", "updatedAt": "Feb 13, 2022 3:22:02 PM", "id": "620921e93c369f6fee8fa16a" }, { "createdAt": "Feb 13, 2022 3:21:13 PM", "isRecordEditable": false, "buildingBlock": "orderItems", "record": { "channelOrderID": "ESBPB04404", "quantity": 1.0, "orderItemID": "WA1000824449-1", "customerOrderID": "WA1000824449", "inventoryStatus": "Unfulfillable", "refOrderItemID": "WA1000824449-1", "ean": "8907819861537", "productImage": "https://buywclothes.com/promotions/SS20/Aurelia/Inward/20FED10283-501401_1.JPG", "orderItemStatus": "CANCELLED", "shipmentID": "620921e93c369f6fee8fa169", "shipmentId": [ "ESBPB04404-1491-86", "ESBPB04404-1491-86" ], "traceabilityLevel": "Item level", "Orderitemcreated at": "Feb 13, 2022 3:21:13 PM", "esin": "8907819861537", "sku": "8907819861537", "orderCreatedAt": "Feb 13, 2022 12:00:00 AM", "productType": "Product" }, "nextActions": [], "previousAction": "createOrderItem", "updatedAt": "Feb 13, 2022 3:22:02 PM", "id": "620921e93c369f6fee8fa16b" }, { "createdAt": "Feb 13, 2022 3:21:13 PM", "isRecordEditable": false, "buildingBlock": "orderItems", "record": { "channelOrderID": "ESBPB04404", "quantity": 1.0, "orderItemID": "WA1000824449-3", "customerOrderID": "WA1000824449", "inventoryStatus": "Unfulfillable", "refOrderItemID": "WA1000824449-3", "upc": "8907819953836", "ean": "8907819953836", "productImage": "https://buywclothes.com/promotions/MF20/Aurelia/Low_Res_Grey/20AUA11623-701228/20AUA11623-701228_1.JPG", "orderItemStatus": "CANCELLED", "shipmentID": "620921e93c369f6fee8fa169", "shipmentId": [ "ESBPB04404-1491-86", "ESBPB04404-1491-86" ], "traceabilityLevel": "Item level", "Orderitemcreated at": "Feb 13, 2022 3:21:13 PM", "esin": "362TD3GP17V", "sku": "8907819953836", "orderCreatedAt": "Feb 13, 2022 12:00:00 AM", "productType": "Product" }, "nextActions": [], "previousAction": "createOrderItem", "updatedAt": "Feb 13, 2022 3:22:02 PM", "id": "620921e93c369f6fee8fa16c" } ], "paymentMethod": "Prepaid", "fulfillmentPriority": "Low", "orderCreatedAt": "Feb 13, 2022 9:37:08 AM", "remarks": "fulfillment_cancel", "Shipmentcreated at": "Feb 13, 2022 3:21:13 PM", "expectedFulfillmentBy": "Feb 14, 2022 10:30:00 AM", "shipmentStatus": "CREATED" }, "nextActions": [], "id": "620921e93c369f6fee8fa169", "updatedAt": "Feb 13, 2022 3:22:02 PM" } }

  3. If the eventSubType is equal to “createshipment_updated“ and “shipmentStatus“ is equal to “CREATED“ then extract “orderItems“ from the event.
    3.1 Iterate over the orderItems list and check “inventoryStatus“ of each item. If all the orderItems inventoryStatus is equal to “fulfillable”. then only proceed below step otherwise return.
    3.2 Make a HTTP PUT request on WMS mark accepted API.
    API:

    https://{{accountSlug}}.eshopbox.com/api/order/shipment/{{externalShipmentID}}/markAccepted


    Success Response from WMS:

  4. If the eventSubType is equal to “createshipment_updated“ and “shipmentStatus” is equal to “CANCELLED“ then extract “orderItems“ from the event.
    4.1 Iterate over the orderItems list and check “inventoryStatus“ of each item. If any one of the orderItems inventoryStatus is equal to “unfulfillable”. then only proceed below step otherwise return.
    4.2 Prepare a request body for rejecting the order and using the request body make a HTTP POST request on WMS reject order API.
    Request body:

    { "reason": "", "externalChannelID": "CH1055", "cancellationTime": "2022-02-11 09:36:14", "customerOrderNumber": "f902cfe9-4899-49bb-b595-c6b0694d3d7d", "items": [ { "product": "", "quantity": 1, "orderItemID": "12414056799551500-22733740", "inventoryStatus": "Unfulfillable", "esin": "01C6Z3GQM73", "remarks": "fulfillment_cancel" } ], "remarks": "fulfillment_cancel" }


    API:

    https://{{accountSlug}}.eshopbox.com/api/reject-order


    Success Response from WMS:

    { "externalChannelID": "CH1055", "cancellationTime": "2022-02-11 09:36:14", "externalShipmentID": "OD124140567995515000-1055-579", "customerOrderNumber": "f902cfe9-4899-49bb-b595-c6b0694d3d7d", "items": [ { "quantity": 1, "orderItemID": "12414056799551500-22733740", "inventoryStatus": "Unfulfillable", "esin": "01C6Z3GQM73", "remarks": "fulfillment_cancel" } ], "remarks": "fulfillment_cancel" }


    Error Response From WMS:

  5. If the eventSubType is equal to “createshipment_updated“ and “shipmentStatus“ is equal to “PICKED“ then make a HTTP PUT request on WMS mark picked API.
    API:

    https://{{accountSlug}}.eshopbox.com/api/order/shipment/{{externalShipmentID}}/markPicked

  6. If the eventSubType is equal to “handovermanifest_updated“ then we have to mark shipment dispatched on WMS
    6.1 Extract “shipments“ and “sidelinedShipments“ from the event received.
    6.2 We have to mark dispatched only those shipments which have a status equal to “PACKED“ and are not present in “sidelinedShipments“.
    API:

    https://{{accountSlug}}.eshopbox.com/api/order/shipment/{{externalShipmentID}}/markDispatched

     

 

Related content