List Orders

GET

https://api.techrar.com/order/v1/merchant/orders/

This endpoint allows you to list all merchant orders

Permission

can_read_order - orders read only

Filters

You can filter orders with almost all the fields in the order e.g. payment_provider, status, ..etc

Light Objects

In most list endpoints, the returned object will be light.
Use the details endpoint to get a detailed object

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.techrar.com/order/v1/merchant/orders/?search=&search=&page=1&page_size=5&order_by=' \
--header 'app-id: 4' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "count": 174,
    "next": "http://localhost/order/v1/merchant/orders/?order_by=&page=2&page_size=5&search=",
    "previous": null,
    "results": [
        {
            "id": 446,
            "custom_fields": null,
            "customer": {
                "id": 35265,
                "country_code": "966",
                "username": "0535501059",
                "mobile_number": "966535501059",
                "email": "[email protected]",
                "name": "Ozel",
                "lang": "ar",
                "current_city_id": null,
                "is_email_verified": false,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "joined_at": "2025-06-02 12:10:54.881137+00:00",
                "national_id": null,
                "secondary_mobile_number": null,
                "date_of_birth": null,
                "avatar": null,
                "custom_fields": null
            },
            "is_gifted": false,
            "recurring_purchase_id": null,
            "app_id": 86,
            "created_at": "2025-09-02T20:00:36.781103+03:00",
            "customer_buyer_id": 35265,
            "customer_receiver_id": null,
            "status": "pending",
            "source": "other",
            "location_id": null,
            "city_en": null,
            "city_ar": null,
            "district_en": null,
            "district_ar": null,
            "branch_id": null,
            "sub_total_amount": 10.33,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 10.33,
            "sub_total_discounts_amount": 1.03,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 1.03,
            "total_amount": 9.3,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 9.3,
            "currency": "SAR",
            "payment_method": null,
            "payment_provider": null,
            "notes": "",
            "order_reference_id": null,
            "selected_courier_option": null
        },
        {
            "id": 445,
            "custom_fields": null,
            "customer": {
                "id": 35265,
                "country_code": "966",
                "username": "0535501059",
                "mobile_number": "966535501059",
                "email": "[email protected]",
                "name": "Ozel",
                "lang": "ar",
                "current_city_id": null,
                "is_email_verified": false,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "joined_at": "2025-06-02 12:10:54.881137+00:00",
                "national_id": null,
                "secondary_mobile_number": null,
                "date_of_birth": null,
                "avatar": null,
                "custom_fields": null
            },
            "is_gifted": false,
            "recurring_purchase_id": null,
            "app_id": 86,
            "created_at": "2025-09-02T20:00:04.216533+03:00",
            "customer_buyer_id": 35265,
            "customer_receiver_id": null,
            "status": "pending",
            "source": "other",
            "location_id": null,
            "city_en": null,
            "city_ar": null,
            "district_en": null,
            "district_ar": null,
            "branch_id": null,
            "sub_total_amount": 10.33,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 10.33,
            "sub_total_discounts_amount": 0.0,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 0.0,
            "total_amount": 10.33,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 10.33,
            "currency": "SAR",
            "payment_method": null,
            "payment_provider": null,
            "notes": "",
            "order_reference_id": null,
            "selected_courier_option": null
        },
        {
            "id": 444,
            "custom_fields": null,
            "customer": {
                "id": 35265,
                "country_code": "966",
                "username": "0535501059",
                "mobile_number": "966535501059",
                "email": "[email protected]",
                "name": "Ozel",
                "lang": "ar",
                "current_city_id": null,
                "is_email_verified": false,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "joined_at": "2025-06-02 12:10:54.881137+00:00",
                "national_id": null,
                "secondary_mobile_number": null,
                "date_of_birth": null,
                "avatar": null,
                "custom_fields": null
            },
            "is_gifted": false,
            "recurring_purchase_id": null,
            "app_id": 86,
            "created_at": "2025-09-02T19:59:35.118370+03:00",
            "customer_buyer_id": 35265,
            "customer_receiver_id": null,
            "status": "completed",
            "source": "other",
            "location_id": null,
            "city_en": null,
            "city_ar": null,
            "district_en": null,
            "district_ar": null,
            "branch_id": null,
            "sub_total_amount": 10.33,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 10.33,
            "sub_total_discounts_amount": 10.33,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 10.33,
            "total_amount": 0.0,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 0.0,
            "currency": "SAR",
            "payment_method": "free",
            "payment_provider": "techrar",
            "notes": "",
            "order_reference_id": null,
            "selected_courier_option": null
        },
        {
            "id": 443,
            "custom_fields": null,
            "customer": {
                "id": 1,
                "country_code": "966",
                "username": "0534501056",
                "mobile_number": "966534501056",
                "email": "[email protected]",
                "name": "Safwan Saigh",
                "lang": "en",
                "current_city_id": 1,
                "is_email_verified": true,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "joined_at": "2025-04-16 11:30:06.950591+00:00",
                "national_id": "1111782031",
                "secondary_mobile_number": "0534501056",
                "date_of_birth": "1999-02-24",
                "avatar": "/media/uploads/customer/avatars/2024/07/29/12048986-a1b6-4e1d-9b8a-216331f3cd71.png",
                "custom_fields": {
                    "subscription_fields": []
                }
            },
            "is_gifted": false,
            "recurring_purchase_id": null,
            "app_id": 86,
            "created_at": "2025-08-27T12:54:05.123077+03:00",
            "customer_buyer_id": 1,
            "customer_receiver_id": null,
            "status": "canceled",
            "source": "web",
            "location_id": null,
            "city_en": null,
            "city_ar": null,
            "district_en": null,
            "district_ar": null,
            "branch_id": null,
            "sub_total_amount": 100.0,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 100.0,
            "sub_total_discounts_amount": 0.0,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 0.0,
            "total_amount": 100.0,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 100.0,
            "currency": "SAR",
            "payment_method": null,
            "payment_provider": null,
            "notes": "",
            "order_reference_id": null,
            "selected_courier_option": null
        },
        {
            "id": 442,
            "custom_fields": null,
            "customer": {
                "id": 1,
                "country_code": "966",
                "username": "0534501056",
                "mobile_number": "966534501056",
                "email": "[email protected]",
                "name": "Safwan Saigh",
                "lang": "en",
                "current_city_id": 1,
                "is_email_verified": true,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "joined_at": "2025-04-16 11:30:06.950591+00:00",
                "national_id": "1111782031",
                "secondary_mobile_number": "0534501056",
                "date_of_birth": "1999-02-24",
                "avatar": "/media/uploads/customer/avatars/2024/07/29/12048986-a1b6-4e1d-9b8a-216331f3cd71.png",
                "custom_fields": {
                    "subscription_fields": []
                }
            },
            "is_gifted": false,
            "recurring_purchase_id": null,
            "app_id": 86,
            "created_at": "2025-08-27T12:52:15.523490+03:00",
            "customer_buyer_id": 1,
            "customer_receiver_id": null,
            "status": "completed",
            "source": "web",
            "location_id": null,
            "city_en": null,
            "city_ar": null,
            "district_en": null,
            "district_ar": null,
            "branch_id": null,
            "sub_total_amount": 100.0,
            "shipping_amount": 0.0,
            "setup_amount": 0.0,
            "net_amount": 100.0,
            "sub_total_discounts_amount": 0.0,
            "shipping_discounts_amount": 0.0,
            "total_discounts_amount": 0.0,
            "total_amount": 100.0,
            "wallet_redeem_amount": 0.0,
            "total_amount_with_redeem": 100.0,
            "currency": "SAR",
            "payment_method": "visa_master",
            "payment_provider": "myfatoorah",
            "notes": "",
            "order_reference_id": null,
            "selected_courier_option": null
        }
    ]
}

Modified at 2025-10-20 05:34:51

Update Checkout Config

Order Details