Skip to main content

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.

EventStructure​

{
    "shipmentId": "",
    "eventType": "shipment_hold",
    "source": "flipkart",
    "timestamp": "",//ISO String
    "attributes": {
        "orderItems": [{
            "orderItemId": "",
            "holdQuantity": "" //Absolute number
        }]

    }
}
Parameter NameDescription
holdQuantityNumber of units for that order item made hold

Example​

{
    "eventType": "shipment_hold",
    "source": "flipkart",
    "version": "v3",
    "timestamp": "2017-03-28T18:03:01+05:30",
    "attributes": {
        "orderItems": [{
            "orderItemId": "1434562882827100",
            "holdQuantity": 1
        }]
    },
    "shipmentId": "d133588f-b0ac-443b-99b4-7ac8648a0f89"
}