API Reference

Order Complete

This page outlines the ORDER_COMPLETE event, which signifies that an order has been successfully delivered to the customer.

Webhook Data

The following JSON payload is an example of the data you will receive for an ORDER_COMPLETE webhook:

{
    "category": "ORDER_COMPLETE",
    "description": "The order has been delivered to the customer",
    "payload": {
        "id": 1453,
        "total_price": 2130000,
        "reference": "testing119312",
        "status": "completed",
        "summary": " 40 portions of Beef.",
        "source": "api",
        "class": "delivery",
        "currency": "NGN",
        "created_at": "2022-11-25T17:03:40.000Z",
        "updated_at": "2022-11-25T17:03:55.000Z",
        "delivery_price": 80000,
        "time_payment_confirmed": "2022-11-25T17:03:43.000Z",
        "time_customer_received_order": null,
        "actual_delivery_time": null,
        "driver": {},
        "customer": {
            "id": 70,
            "first_name": "Dave",
            "last_name": "Aluks",
            "email": "[email protected]",
            "phone": "08142272922,
            "country_code": null
        },
        "items": [
            {
                "quantity": 40,
                "price_per_quantity": 50000,
                "id": 2408,
                "description": "Pure beef meat"
            }
        ],
        "timeline": [
            {
                "action": "ORDER_CREATED",
                "description": "Order created",
                "created_at": "2022-11-25T17:03:40.000Z"
            },
            {
                "action": "MADE_PAYMENT",
                "description": "Made payment using none",
                "created_at": "2022-11-25T17:03:42.000Z"
            },
            {
                "action": "VENDOR_ACCEPTED_ORDER",
                "description": "Vendor accepted the order",
                "created_at": "2022-11-25T17:03:46.000Z"
            }
        ],
        "customer_address": {
            "id": 531,
            "street": "33 Adisa Coker St, Ojodu 101232, Lagos, Nigeria",
            "pretty_name": "33 Adisa Coker St, Ojodu 101232, Lagos, Nigeria",
            "city": "Ojodu",
            "state": "Lagos",
            "country": "Ni",
            "coordinate": {
                "x": 3.3393804,
                "y": 6.656833100000001
            }
        },
        "vendor_address": {
            "id": 531,
            "street": "33 Adisa Coker St, Ojodu 101232, Lagos, Nigeria",
            "pretty_name": "33 Adisa Coker St, Ojodu 101232, Lagos, Nigeria",
            "city": "Ojodu",
            "state": "Lagos",
            "country": "Ni",
            "coordinate": {
                "x": 3.3393804,
                "y": 6.656833100000001
            }
        },
        "vendor_information": {
            "name": "Suya Spotss"
        }
    }
}