.. _omsellernotif-label: Order Management Notification Reference ======================================= You can use the following event notifications and sample payloads during an shipment lifecycle. .. _push-shipment-create-label: Shipment Created ---------------- **Description** - Notification sent when an shipment is created in seller system. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_created", "locationId": "", "source": "flipkart", "timestamp": "",//ISO String "attributes": { "dispatchByDate": "DateTime", "dispatchAfterDate": "DateTime", "hold": false, "mps": false, "packagingPolicy": "GREEN_PACKAGE", "orderItems": [{ "fsn": "", "quantity": 0, "orderId": "", "orderItemId": "", "listingId": "", "hsn": "String", "sku": "", "title": "String", "paymentType": "", "cancellationGroupId": "", "isReplacement": false, "priceComponents": { "sellingPrice": 0, "totalPrice": 0, "shippingCharge": 0, "customerPrice": 0, "flipkartDiscount": 0 }, "orderDate": "DateTime", "status": "OrderItemState", "packageIds": [] }], "forms": [{ "name": "", "link": "", "automated": false }], "subShipments": [{ "subShipmentId": "", "packages": [{ "packageId": "", "packageTitle": "", "packageSku": "", "dimensions": { "length": 0, "breadth": 0, "height": 0, "weight": 0 } }] }] } } **Attributes** +---------------------+---------------------------------------------------------+ |Parameter Name | Description | +=====================+=========================================================+ |``status`` | Possible value - ``APPROVED`` | +---------------------+---------------------------------------------------------+ |``packagingPolicy`` | Possible value - ``GREEN_PACKAGE``, ``DEFAULT``, ``NA``| +---------------------+---------------------------------------------------------+ | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_created", "source": "flipkart", "version": "v3", "locationId" : "LOC1234", "timestamp": "2017-03-28T18:03:01+05:30", "attributes": { "dispatchByDate": "2017-04-10T10:00:00.000+05:30", "dispatchAfterDate": "2017-04-06T18:21:25.000+05:30", "updatedAt": "2017-04-06T18:17:01.000+05:30", "hold": false, "mps": false, "subShipments": [{ "subShipmentId": "SS-1", "packages": [] }], "packagingPolicy": "GREEN_PACKAGE", "orderItems": [{ "orderItemId": "1883380307363600", "orderId": "OD108833803073636000", "cancellationGroupId": "grp1883380307363600", "orderDate": "2017-04-06T18:15:57.000+05:30", "paymentType": "COD", "status": "APPROVED", "quantity": 1, "fsn": "DIAE777EDCWNZSPZ", "sku": "LKA041150", "listingId": "LSTDIAE777EDCWNZSPZQMLAT0", "hsn": null, "title": "Lokalart Pocket-size Journal Yellow LKA041150", "packageIds": [], "priceComponents": { "sellingPrice": 295.0, "totalPrice": 295.0, "shippingCharge": 0.0, "customerPrice": 295.0, "flipkartDiscount": 0.0 }, "is_replacement": false }], "forms": [{ "name": "GJ_403", "link": "http://www.commercialtax.gujarat.gov.in/", "automated": true }], "dispatchLocation": null }, "shipmentId": "dc455f0e-b2f2-473a-9731-360ffbb23348" } | | .. _push-hold-label: Hold ---- **Description** - Notification sent when a shipment is flagged as ``Hold`` for COD, address, buyer authenticity, or other verifications. A shipment can be put on hold at any stage in a transaction. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_hold", "source": "flipkart", "timestamp": "",//ISO String "attributes": { "orderItems": [{ "orderItemId": "", "holdQuantity": "" //Absolute number }] } } **Attributes** ================ ======================= Parameter Name Description ================ ======================= ``holdQuantity`` Number of units for that order item made hold ================ ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_hold", "source": "flipkart", "version": "v3", "timestamp": "2017-03-28T18:03:01+05:30", "attributes": { "orderItems": [{ "orderItemId": "1434562882827100", "holdQuantity": 1 }] }, "shipmentId": "d4462594-975a-4a7c-b155-24dc3072a81d" } | | .. _push-unhold-label: UnHold ------ **Description** - Notification sent after a shipment , which was flagged as ``Hold``, is released for further processing after making relevant verifications. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_unhold", "source": "flipkart", "timestamp": ISO time string, "attributes": { "status": "APPROVED" } } **Attributes** ============== ======================= Parameter Name Description ============== ======================= ``status`` Possible value - ``APPROVED``, ``PACKED`` ============== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_unhold", "source": "flipkart", "version": "v3", "timestamp": "2017-03-28T18:03:01+05:30", "attributes": { "status": "PACKED" }, "shipmentId": "06837906-5857-449a-be93-b465f4d349a1" } | | .. _push-pack-label: Packed ------ **Description** - Notification sent when an shipment state is changed to ``PACKED``. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_packed", "source": "flipkart", "timestamp": ISO time string, "attributes": { "status": "PACKED" } } **Attributes** ============== ======================= Parameter Name Description ============== ======================= ``status`` Possible value - ``PACKED`` ============== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_packed", "source": "flipkart", "version": "v3", "timestamp": "2017-03-30T14:45:25+05:30", "attributes": { "status": "PACKED" }, "shipmentId": "870cbeb2-33f4-4ba8-a3de-5bc2f90625d3" } | | .. _push-rtd-label: Ready To Dispatch ----------------- **Description** - Notification sent when an shipment is marked “Ready to Dispatch” by the seller. Event Structure ~~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_ready_to_dispatch", "source": "flipkart", "timestamp": ISO time string, "attributes": { "status": "READY_TO_DISPATCH" } } **Attributes** ============== ======================= Parameter Name Description ============== ======================= ``status`` Possible value - ``READY_TO_DISPATCH`` ============== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_ready_to_dispatch", "source": "flipkart", "version": "v3", "timestamp": "2017-03-30T14:45:25+05:30", "attributes": { "status": "READY_TO_DISPATCH" }, "shipmentId": "870cbeb2-33f4-4ba8-a3de-5bc2f90625d3" } | | .. _push-pickup-label: Pickup Complete --------------- **Description** - Notification sent when the shipment is picked up by the logistics team. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_pickup_complete", "source": "flipkart", "timestamp": ISO time string, "attributes": { "status": "PICKUP_COMPLETE" } } **Attributes** ============== ======================= Parameter Name Description ============== ======================= ``status`` Possible value - ``PICKUP_COMPLETE`` ============== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_pickup_complete", "source": "flipkart", "version": "v3", "timestamp": "2017-03-30T14:45:25+05:30", "attributes": { "status": "PICKUP_COMPLETE" }, "shipmentId": "870cbeb2-33f4-4ba8-a3de-5bc2f90625d3" } | | .. _push-ship-label: Shipped ------- **Description** - Notification sent when a shipment is shipped to the delivery hub. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_shipped", "source": "flipkart", "timestamp": ISO time string, "attributes": { "status": "SHIPPED" } } **Attributes** ============== ======================= Parameter Name Description ============== ======================= ``status`` Possible value - ``SHIPPED`` ============== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_shipped", "source": "flipkart", "version": "v3", "timestamp": "2017-04-10T23:05:15+05:30", "attributes": { "status": "SHIPPED" }, "shipmentId": "dfbf867b-2775-4585-9159-4a3de099c0e7" } | | .. _push-deliver-label: Delivered --------- **Description** - Notification sent when a shipment is delivered to the buyer. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_delivered", "source": "flipkart", "timestamp": ISO time string, "attributes": { "status": "DELIVERED" } } **Attributes** ============== ======================= Parameter Name Description ============== ======================= ``status`` Possible value - ``DELIVERED`` ============== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_delivered", "source": "flipkart", "version": "v3", "timestamp": "2017-04-10T23:16:06+05:30", "attributes": { "status": "DELIVERED" }, "shipmentId": "dfbf867b-2775-4585-9159-4a3de099c0e7" } | | .. _push-sla-label: Dispatch Dates Changed ---------------------- **Description** - Notification sent when there is a change in the shipment dispatch dates. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_dispatch_dates_changed", "source": "flipkart", "timestamp": ISO time string, "attributes": { "dispatchAfterDate": "" //New dispatch after date "dispatchByDate": "" //New dispatch by date } }} **Attributes** ===================== ======================= Parameter Name Description ===================== ======================= ``dispatchAfterDate`` The new date of dispatch. ISO time string ``dispatchByDate`` The new date of dispatch. ISO time string ===================== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_dispatch_dates_changed", "source": "flipkart", "version": "v3", "timestamp": "2017-03-28T18:03:01+05:30", "attributes": { "dispatchAfterDate": "2017-03-27T23:59:59.000+05:30", "dispatchByDate": "2017-03-28T23:59:59.000+05:30" }, "shipmentId": "5ffa764f-6081-4a37-a45e-cd9815cbc73b" } | | .. _push-cancel-label: Shipment Cancelled ------------------- **Description** - Notification sent when any order item inside the shipment is cancelled. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_cancelled", "locationId": "", "source": "", "timestamp": ISO time string, "attributes": { "status": "CANCELLED", "orderItems": [{ "orderItemId": "", "quantity": , "reason": "", "subReason": "" }] } } **Attributes** ============== ======================= Parameter Name Description ============== ======================= ``status`` Possible value - ``CANCELLED`` ``quantity`` Number of quantity cancelled for that order item id ============== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_cancelled", "source": "flipkart", "version": "v3", "timestamp": "2017-04-12T12:12:15+05:30", "locationId" : "LOC1234", "attributes": { "status": "CANCELLED", "orderItems": [{ "orderItemId": "6452425382623300", "quantity": 1, "reason": "seller_cancellation", "subReason": "not_enough_inventory" }] }, "shipmentId": "6ddce370-20d3-426a-a095-431e840afe9b" } | | .. _push-form-failed-label: Shipment Form Failed --------------------- **Description** - Notification sent when form generation for any shipment failed from flipkart end. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "shipmentId": "", "eventType": "shipment_form_failed", "source": "", "timestamp": ISO time string, "attributes": { "status": "FORM_FAILED", "forms":[] } } **Attributes** ============== ======================= Parameter Name Description ============== ======================= ``status`` Possible value - ``FORM_FAILED`` ============== ======================= | Example ~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "eventType": "shipment_form_failed", "source": "flipkart", "version": "v3", "timestamp": "2017-03-28T18:03:01+05:30", "attributes": { "status": "FORM_FAILED", "forms": ["FORM600TG"] }, "shipmentId": "18cf145e-f452-41a9-8ee3-ea674e01bf60" } | | .. _push-createreturn-label: Return Created -------------- **Description** - Notification sent when a new return request is created. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "returnId" : "", "eventType" : "return_created", "source" : "", "timestamp" : ISO time string, "locationId" : "", "attributes" : { "status" : "RETURN_CREATED", "returnItems" : [{ "returnId" : "", // primary identifier of the return "orderItemId" : "", // order item id against which this return is created "source" : "" , // possible values are courier_return, customer_return "action" : "" , "quantity" : , // item quantity in the return "orderDate" : "", // created date of the order "createdDate" : "", "updatedDate" : "", "courierName" : "", "reason" : "", "subReason" : "", "trackingId" : "", "shipmentId" : "", "comments" : "", "completionDate" : "", "replacementOrderItemId" : "", "productId" : "", "listingId" : "", "expectedDate" : "" // Date on which return is expected to be delivered to seller warehouse }] } } | | .. _push-tracking-id-label: Return Tracking Id Update -------------------------- **Description** - Notification sent when tracking details for a customer return is updated. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "returnId": "", "eventType": "return_item_tracking_id_update", "source": "", "timestamp": "",//ISO String "attributes": { "returnItems": [{ "orderItemId": "", "trackingId": "", //Return tracking id "courierName": "" // Return courier name }] } } | | .. _push-returnexpected-label: Return Expected Date Changed ---------------------------- **Description** - Notification sent when the expected date of return of an orderItem changes. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "returnId" : "", "eventType" : "return_expected_date_changed", "source" : "", "locationId" : "", "timestamp" : ISO time string, "attributes" : { "returnItems" : [{ "orderItemId": "", // order item id for which this return is processed "expectedDate": "" // new expected date for the return }] } } | | .. _push-pickedupreturn-label: Return PickedUp -------------- **Description** - Notification sent when a return is picked up Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "returnId" : "", "eventType" : "return_picked_up", "source" : "", "locationId" : "", "timestamp" : ISO time string, "attributes" : { "status": "RETURN_PICKED_UP", "returnItems" : [{ "orderItemId": "" //order item id for which the return is picked up }] } } | | .. _push-completereturn-label: Return Completed ---------------- **Description** - Notification sent after processing and completing a return request. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "returnId" : "", "eventType" : "return_completed", "source" : "", "locationId" : "", "timestamp" : ISO time string, "attributes" : { "status": "RETURN_COMPLETED", "returnItems" : [{ "orderItemId": "" // order item id for which this return is processed }] } } | | .. _push-cancelreturn-label: Return Cancelled ---------------- **Description** - Notification sent when a return request is revoked. Event Structure ~~~~~~~~~~~~~~~ .. container:: toggle .. container:: header **☰ SHOW | HIDE** :: { "returnId" : "", "eventType" : "return_cancelled", "source" : "", "locationId" : "", "timestamp" : ISO time string, "attributes" : { "status": "RETURN_CANCELLED", "returnItems" : [{ "orderItemId": "" // order item id for which this return is processed }] } } | |