Skip to main content

Order Details

Get Order Details​

Retrieves the details of a specific order in the customer's order history.

  • Endpoint: api/customer/orders/{id/uuid}

  • Http Method: GET

  • URL Parameters:

    • id/uuid (required): The unique identifier of the order. For guest orders, this will be a UUID, and for authenticated customer orders.
Orders Resource

Check the following section to learn more about the Orders Resource.

  • Success Response:
200 OK - If the order details is successful
{
    "code": 200,
    "message": "Success",
    "data": {
        "id": 66777,
        "uuid": "2161d544-ed3e-4771-b853-7e3bae3a2bb5",
        "user": {
            "full_name": "Test Documentation",
            "phone": "01111111115",
        },
        "date": "2023-04-09 11:09:33",
        "user_agent": "web",
        "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://api.alabdellatif-tarshouby.com/storage/uploads/110248.jpg",
                "price": 350,
                "discount_price": null,
                //...
            }
        ],
        "missing_items": [],
        "returned_items": [],
        "address": {
            "id": 49124,
            "formatted_address_ar": "مبني 10, دور 1, شارع test address, شقة 1, المعادي, القاهرة",
            "formatted_address_en": "building 10, floor 1, address test address, apartment 1, Maadi, Cairo",
            "district": null,
            "area": {
                "id": 125,
                "name": "Maadi",
                //...
            },
            "city": {
                "id": 10,
                "name": "Cairo",
                "name_ar": "القاهرة",
                //...
            }
        },
        "notes": null,
        "invoice": {
            "id": 63946,
            "delivery_fees": 0,
            "discount": null,
            "free_delivery": 0,
            "grand_total": 350,
            "invoice_number": null,
            "tax_amount": 0,
            "total_amount": 350,
            "refund_amount": 0,
            "total_invoice": 350,
            //...
        },
        "total": 350,
        "item_total": 350,
        "item_total_discount": null,
        "delivery_fees": 0,
        "discount": 0,
        "active": true,
        "scheduled_at": "2023-04-10 00:00:00",
        "schedule": null,
        "total_delivery_fees": 0,
        "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": []
        },
        "branch": null,
        "time_slot_en": "Tomorrow, 10:00 AM - 05:00 PM",
        "time_slot_ar": "غدا, 10:00 ص - 05:00 م",
        "wallet_paid_amount": 0,
        "online_paid_amount": 0,
        "loyalty_discount": 0,
        "item_total_exc_vat": 350,
        "item_total_discount_exc_vat": null,
        "returned_invoice": []
    }
}
info

Check the following section to learn more about the Order Details API Reference

Get Sub Orders​

The "Get Sub Orders List by Reference UUID" API allows users to retrieve a list of sub-orders associated with a specific reference UUID. Sub-orders are typically linked to a primary order and can represent individual items within a larger order. This API facilitates the retrieval of sub-order details for reference and tracking purposes.

  • Endpoint: api/customer/orders/{referenceUUID}/sub-orders

  • Http Method: GET

  • URL Parameters:

    • reference_uuid (required): The unique identifier (UUID) of the order.

  • Success Response:

{
    "code": 200,
    "data": [
        {
            "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": []
        }
    ],
}
info

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