Amendments

When a store processes amendments for one or more items within an order, this webhook will deliver the amendment details

{
    "channelOrderId": "TEST******4206",
    "channelLink": "61********************c3",
    "itemAmendments": [
        {
            "amends": {
                "plu": "BURG1",
                "quantity": 1,
                "subItems": [
                    {
                        "plu": "MOD1",
                        "quantity": 1,
                        "subItems": [
                            {
                                "plu": "MOD5",
                                "quantity": 1,
                                "subItems": []
                            }
                        ]
                    }
                ]
            },
            "finalQuantity": 0,
            "amendmentAction": "ADJUST",
            "amendmentReason": "OUT_OF_STOCK"
        }
    ]
}
{
    "channelOrderId": "TEST******4206",
    "channelLink": "61********************c3",
    "itemAmendments": [
        {
            "amends": {
                "plu": "COLA1",
                "quantity": 1
            },
            "finalQuantity": 2
        }
    ]
}
{
    "channelOrderId": "TEST******4206",
    "channelLink": "61********************c3",
    "itemAmendments": [
        {
            "amends": {
                "plu": "COLA1",
                "quantity": 1,
                "subItems": []
            },
            "finalQuantity": 1,
            "amendmentAction": "REPLACE",
            "amendmentReason": "OUT_OF_STOCK",
            "substitutePlu": "LEM2"
        }
    ]
}

Definitions

AttributeMeaningType
amends.pluUnique identifier of the amended itemString
amends.quantityOriginal quantity of the item orderedInteger
amends.subItemsWhere applicable, subItems associated with the item orderedObject
finalQuantityUpdated quantity of the item orderedString
amendmentReasonStated reason for amending the item if availableEnum string
amendmentActionEnum string
substitutePluString
Language