Skip to main content

Get Orders History

The Get Order History API provides a list of all the orders that a user has made on an e-commerce website.

  • Endpoint: api/customer/orders

  • Http Method: GET

  • Success Response:

KeyDescription
orderGet orders history array of objects.
totalThe total of the orders.
200 OK - If the order histories is successful
{
    "code": 200,
    "data": {
        "order": [
            {
                "id": 66777,
                "uuid": "2161d544-ed3e-4771-b853-7e3bae3a2bb5",
                "user": {
                    "id": 1017390,
                    "full_name": "Test Documentation",
                    //...
                },
                "date": "2023-04-09 11:09:33",
                "payment_method": 1,
                "phone": "01111111115",
                "state": {
                    "id": 1,
                    "name": "Placed",
                    "name_ar": "تم الطلب"
                },
                "items": [
                    {
                        "id": 136160,
                        "amount": 1,
                        "sku": "110248",
                        "name": "Manzanilla Oro Lightening Hair Lotion 180 ml",
                        "name_ar": "مانزانيلا أورو لوشن لتفتيح الشعر 180 مل",
                        "image": "https://docapi.supercommerce.io/storage/uploads/110248.jpg",
                        "price": 350,
                        "discount_price": null,
                    }
                ],
                "missing_items": [],
                "returned_items": [],
                "address": {
                    "id": 49124,
                    "address": "test address",
                    //..
                },
                "installment": [],
                "invoice": {
                    //...
                },
                "total": 350,
                "item_total": 350,
                "item_total_discount": null,
                "delivery_fees": 0,
                "discount": 0,
                "active": true,
                "scheduled_at": "2023-04-10 00:00:00",
                "total_delivery_fees": 0,
                "free_delivery": false,
                "payment_method_object": {
                    "id": 1,
                    "name": "Cash On Delivery",
                    "name_ar": "الدفع عند الاستلام",
                    "is_online": 0,
                    "type": 0,
                    "icon": "https://docapi.supercommerce.io/images/payment_methods/cash_payment.png",
                    "plans": []
                },
                "time_slot_en": "Tomorrow, 10:00 AM - 05:00 PM",
                "time_slot_ar": "غدا, 10:00 ص - 05:00 م",
                "returned_invoice": []
            }
        ],
        "total": 1
    }
}
info

Check the following section to learn more about the Get Orders History API Reference