Order Management Notification Reference

You can use the following event notifications and sample payloads during an order lifecycle.

Order Created

Description - Notification sent when an order is placed.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId" : "",
    "eventType" : "order_item_created",
    "source" : "flipkart"
    "timestamp" : ISO time string
    "attributes" : {
        "orderItemId": "",
        "orderId": "",
        "status" : "APPROVED",
        "hold": Boolean (true/false),
        "orderDate" : ISO time String,
        "dispatchAfterDate" : "",
        "dispatchByDate" : "",
        "sla" : ""
        "quantity" :
        "title" : "",
        "listingId" : "",
        "fsn" : "",
        "sku" : "",
        "shippingPincode":,
        "priceComponents": [
            "sellingPrice":"",
            "customerPrice":"",
            "shippingCharge":"",
            "totalPrice":""
        ],
        "stateDocuments" : [""],
        "subItems" : [{
            "orderItemId": "",
            "status" : "",
            "hold":Boolean(true/false)true ,
            "orderDate" : ISO time String,
            "dispatchAfterDate" : "",
            "dispatchByDate" : "",
            "sla" : ""
            "quantity" :
            "title" : "",
            "listingId" : "",
            "fsn" : "",
            "sku" : "",
            "priceComponents": [
                "sellingPrice":"",
                "customerPrice":"",
                "shippingCharge":"",
                "totalPrice":""
            ],
            "stateDocuments" : [""]
        }]
    }
}

Attributes

Parameter Name Description
status Possible value - APPROVED

Example

☰ SHOW | HIDE
{
    "orderItemId" : "",
    "eventType" : "order_item_created",
    "source" : "flipkart"
    "timestamp" : ISO time string
    "attributes" : {
        "orderItemId": "OID1179576",
        "orderId": "OD30423223",
        "status": "APPROVED",
        "hold": true,
        "orderDate": "2014-07-18T10:00:00Z",
        "dispatchAfterDate": "2014-07-19T10:00:00Z",
        "dispatchByDate": "2014-07-20T10:00:00Z",
        "sla": 1,
        "quantity": 1,
        "title": "Samsung Galaxy S3 Pebble Blue",
        "listingId": "LSTMOBDACGHGSMVG9VSIQLWV5",
        "fsn": "MOBDACGHGSMVG9VS",
        "sku": "1",
        "priceComponents": [
            "sellingPrice":200,
            "customerPrice":160,
            "shippingCharge":20,
            "totalPrice":180
        ],
        "shippingPincode":"560001",
        "stateDocuments": ["eSugam"],
        "subItems": [{
            "orderItemId": "OID1179577",
            "orderId": "OD30423223",
            "status": "APPROVED",
            "hold":true,
            "quantity": 1,
            "title": "Skullcandy 2XL Headphone Black Shakedown X5SHFZ-820",
            "listingId": "LSTACCDB56E2HUNGVNMPLEDW2",
            "fsn": "ACCDB56E2HUNGVNM",
            "sku": "Seller SKU Id",
            "priceComponents": [
                "sellingPrice":200,
                "customerPrice":0,
                "shippingCharge":0,
                "totalPrice":0
            ],
            "shippingPincode":"560001"
            "orderDate": "2014-07-18T10:00:00Z",
            "dispatchAfterDate": "2014-07-19T10:00:00Z",
            "dispatchByDate": "2014-07-20T10:00:00Z",
            "sla": 1
        }]
    }
}


Hold

Description - Notification sent when an order item is flagged as “Hold” for COD, address, buyer authenticity, or other verifications. An order item can be put on hold at any stage in a transaction.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": ,
    "eventType": "order_item_hold",
    "source": "flipkart",
    "timestamp": ISO time string,
    "attributes": {
        "status": "APPROVED"
    }
}

Attributes

Parameter Name Description
status Possible value - APPROVED, PACKED

Example

☰ SHOW | HIDE
{
    "orderItemId": 1216300,
    "eventType": "order_item_hold",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "status": "APPROVED"
    }
}


UnHold

Description - Notification sent after an order item , which was flagged as “Hold”, is released for further processing after making relevant verifications.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": "",
    "eventType": "order_item_un_hold",
    "source": "flipkart",
    "timestamp": ISO time string,
    "attributes": {
        "status": "APPROVED"
    }
}

Attributes

Parameter Name Description
status Possible value - APPROVED, PACKED

Example

☰ SHOW | HIDE
{
    "orderItemId": "1216300",
    "eventType": "order_item_un_hold",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "status": "APPROVED"
    }
}


Packed

Description - Notification sent when an order item state is changed to packed.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": "",
    "eventType": "order_item_packed",
    "source": "flipkart",
    "timestamp": ISO time string,
    "attributes": {
        "status": "PACKED"
    }
}

Attributes

Parameter Name Description
status Possible value - PACKED

Example

☰ SHOW | HIDE
{
    "orderItemId": "1216300",
    "eventType": "order_item_packed",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "status": "PACKED"
    }
}


Ready To Dispatch

Description - Notification sent when an order item (may include sub-items) is marked “Ready to Dispatch” by the seller.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": "",
    "eventType": "order_item_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

☰ SHOW | HIDE
{
    "orderItemId": "1216300",
    "eventType": "order_item_ready_to_dispatch",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "status": "READY_TO_DISPATCH"
    }
}


Pickup Complete

Description - Notification sent when the shipment is picked up by the logistics team.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": "",
    "eventType": "order_item_pickup_complete",
    "source": "flipkart",
    "timestamp": ISO time string,
    "attributes": {
        "status": "PICKUP_COMPLETE"
    }
}

Attributes

Parameter Name Description
status Possible value - PICKUP_COMPLETE

Example

☰ SHOW | HIDE
{
    "orderItemId": "1216300",
    "eventType": "order_item_pickup_complete",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "status": "PICKUP_COMPLETE"
    }
}


Shipped

Description - Notification sent when an order item is shipped to the delivery hub.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": "",
    "eventType": "order_item_shipped",
    "source": "flipkart",
    "timestamp": ISO time string,
    "attributes": {
        "status": "SHIPPED"
    }
}

Attributes

Parameter Name Description
status Possible value - SHIPPED

Example

☰ SHOW | HIDE
{
    "orderItemId": "1216300",
    "eventType": "order_item_shipped",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "status" : "SHIPPED"
    }
}


Delivered

Description - Notification sent when an order item is delivered to the buyer.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": "",
    "eventType": "order_item_delivered",
    "source": "flipkart",
    "timestamp": ISO time string,
    "attributes": {
        "status": "DELIVERED"
    }
}

Attributes

Parameter Name Description
status Possible value - DELIVERED

Example

☰ SHOW | HIDE
{
    "orderItemId": "1216300",
    "eventType": "order_item_delivered",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "status": "DELIVERED"
    }
}


Dispatch Dates Changed

Description - Notification sent when there is a change in the order item dispatch dates.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": "",
    "eventType": "order_item_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

☰ SHOW | HIDE
{
    "orderItemId": 1216300,
    "eventType": "order_item_dispatch_dates_changed",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "dispatchAfterDate": "2015-03-07T00:00:00Z"
        "dispatchByDate": "2015-03-08T00:00:00Z"
    }
}


Return Created

Description - Notification sent when a new return request is created.

Event Structure

☰ SHOW | HIDE
{
    "returnId" : "",
    "eventType" : "return_created",
    "source" : "",
    "timestamp" : ISO time string,
    "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
        }]
    }
}


Return Expected Date Changed

Description - Notification sent when the expected date of return of an orderItem changes.

Event Structure

☰ SHOW | HIDE
{
    "returnId" : "",
    "eventType" : "return_expected_date_changed",
    "source" : "",
    "timestamp" : ISO time string,
    "attributes" : {
        "returnItems" : [{
        "orderItemId": "", // order item id for which this return is processed
        "expectedDate": ""  // new expected date for the return
        }]
    }
}


Return Completed

Description - Notification sent after processing and completing a return request.

Event Structure

☰ SHOW | HIDE
{
    "returnId" : "",
    "eventType" : "return_completed",
    "source" : "",
    "timestamp" : ISO time string,
    "attributes" : {
        "status":  "RETURN_COMPLETED",
        "returnItems" : [{
            "orderItemId": "" // order item id for which this return is processed
        }]
    }
}


Return Cancelled

Description - Notification sent when a return request is revoked.

Event Structure

☰ SHOW | HIDE
{
    "returnId" : "",
    "eventType" : "return_cancelled",
    "source" : "",
    "timestamp" : ISO time string,
    "attributes" : {
        "status":  "RETURN_CANCELLED",
        "returnItems" : [{
            "orderItemId": "" // order item id for which this return is processed
        }]
    }
}


Cancelled

Description - Notification sent when an order item approved by the Flipkart Marketplace is cancelled.

Event Structure

☰ SHOW | HIDE
{
    "orderItemId": ,
    "eventType": "order_item_cancelled",
    "source": "",
    "timestamp": ISO time string,
    "attributes": {
        "status": "CANCELLED",
        "cancelledQuantity": , //Absolute number
        "cancellationReason": ""
    }
}

Attributes

Parameter Name Description
status Possible values - CANCELLED
cancelledQuantity The absolute number of order items cancelled
cancellationReason Optional. The reason for cancellation

Example

☰ SHOW | HIDE
{
    "orderItemId": "1216300",
    "eventType": "order_item_cancelled",
    "source": "flipkart",
    "timestamp": "2015-03-05T00:00:00Z",
    "attributes": {
        "status": "CANCELLED",
        "cancelledQuantity": 2,
        "cancellationReason": "duplicate_order"
    }
}