List Orders

GET

https://app.gotreek.com/api/orders

Orders

Last modified:2025-12-29 12:36:58

Order search endpoint with status and date filtering, with optional shipping partners and rate calculation.

💡

Authentication

Bearer token authentication is required.

Only orders belonging to the authenticated merchant are returned.

💡

Filtering
Filter by status using
?status=pending|processing|awaiting_pickup
|delivered|cancelled.

Filter by creation date range using
?date_from=YYYY-MM-DD, ?date_to=YYYY-MM-DD, or both combined.

📌

Pagination

Results are paginated using Laravel’s pagination.

Use ?page= and ?per_page= to control paging .

The data field contains the paginator object: current_page, data (list of orders), per_page, total, last_page, etc.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Token URL: https://app.gotreek.com/api/auth/login

Query Params

Header Params

Responses

🟢200

application/json

Orders retrieved successfully

Body

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://app.gotreek.com/api/orders?page&per_page&status=pending&date_from&date_to' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 43978,
                "order_number": "17676030724246",
                "status": "pending",
                "date": "2026-01-05 08:51:12",
                "order_grand_total": 1601,
                "currency": "SAR",
                "description": null,
                "payment_method": "paid",
                "receiver_first_name": "testorderbox",
                "receiver_last_name": "testorderbox",
                "receiver_phone": "+966501234567",
                "receiver_email": null,
                "receiver_short_address": "RRRD2929",
                "receiver_country_id": 1,
                "receiver_country": null,
                "receiver_country_code": null,
                "receiver_city": null,
                "receiver_address_line": "testapidogprod",
                "receiver_street_name": null,
                "receiver_block": null,
                "receiver_postal_code": null,
                "receiver_latitude": null,
                "receiver_longitude": null,
                "shipper_name": "تست",
                "shipper_email": null,
                "shipper_phone": "+966533112592",
                "shipper_country_id": 1,
                "shipper_city": "جدة",
                "shipper_address_line": "الهنداوية شارع زهرة اللوتس مقابل تموينات التوفير ",
                "shipper_street_name": null,
                "shipper_block": null,
                "shipper_postal_code": null,
                "shipper_latitude": null,
                "shipper_longitude": null,
                "shipper_short_address": null,
                "total_weight": 0,
                "merchant_id": null,
                "delivered_at": null,
                "tax": 0,
                "external_id": null,
                "webhook_id": null,
                "created_at": "2026-01-05T08:51:12.000000Z",
                "updated_at": "2026-01-05T08:51:12.000000Z",
                "warehouse_id": 207,
                "receiver_city_id": 62,
                "cod_wallet_id": null,
                "shipment_external_id": null,
                "selected_shipment_company": null,
                "source": "manual",
                "return_type": null,
                "volumetric_divisor": null,
                "merchant_shipment_id": null,
                "return_ordered_at": null,
                "items": [
                    {
                        "id": 62504,
                        "order_id": 43978,
                        "name": "غطاء أيفون 15",
                        "sku": null,
                        "quantity": 2,
                        "weight": 1,
                        "weight_unit": null,
                        "price": 100,
                        "total_price": null,
                        "tax": null,
                        "currency": "SAR",
                        "created_at": "2026-01-05T08:51:12.000000Z",
                        "updated_at": "2026-01-05T08:51:12.000000Z",
                        "verification_status": "pending",
                        "verified_at": null,
                        "verified_by": null,
                        "wrong_attempts": 0,
                        "verification_note": null
                    },
                    {
                        "id": 62505,
                        "order_id": 43978,
                        "name": "غطاء أيفون",
                        "sku": null,
                        "quantity": 2,
                        "weight": 0,
                        "weight_unit": null,
                        "price": 100,
                        "total_price": null,
                        "tax": null,
                        "currency": "SAR",
                        "created_at": "2026-01-05T08:51:12.000000Z",
                        "updated_at": "2026-01-05T08:51:12.000000Z",
                        "verification_status": "pending",
                        "verified_at": null,
                        "verified_by": null,
                        "wrong_attempts": 0,
                        "verification_note": null
                    }
                ],
                "boxes": [
                    {
                        "id": 33041,
                        "order_id": 43978,
                        "box_id": null,
                        "length": 123,
                        "width": 123,
                        "height": 123,
                        "weight": 12300,
                        "packaging_type_id": 1,
                        "created_at": "2026-01-05T08:51:12.000000Z",
                        "updated_at": "2026-01-05T08:51:12.000000Z"
                    }
                ]
            },
            {
                "id": 43977,
                "order_number": "17675519237676",
                "status": "pending",
                "date": "2026-01-04 18:39:05",
                "order_grand_total": 1234,
                "currency": "SAR",
                "description": null,
                "payment_method": "paid",
                "receiver_first_name": "test",
                "receiver_last_name": "test",
                "receiver_phone": "+966512365478",
                "receiver_email": null,
                "receiver_short_address": null,
                "receiver_country_id": 1,
                "receiver_country": null,
                "receiver_country_code": null,
                "receiver_city": null,
                "receiver_address_line": "Test address",
                "receiver_street_name": null,
                "receiver_block": null,
                "receiver_postal_code": null,
                "receiver_latitude": null,
                "receiver_longitude": null,
                "shipper_name": "تجربة بداية ",
                "shipper_email": null,
                "shipper_phone": "+966533112592",
                "shipper_country_id": 1,
                "shipper_city": "Jeddah",
                "shipper_address_line": "الهنداوية شارع زهرة اللوتس مقابل تموينات التوفير ",
                "shipper_street_name": null,
                "shipper_block": null,
                "shipper_postal_code": null,
                "shipper_latitude": null,
                "shipper_longitude": null,
                "shipper_short_address": null,
                "total_weight": 1,
                "merchant_id": null,
                "delivered_at": null,
                "tax": 0,
                "external_id": null,
                "webhook_id": null,
                "created_at": "2026-01-04T18:39:05.000000Z",
                "updated_at": "2026-01-04T18:39:05.000000Z",
                "warehouse_id": 207,
                "receiver_city_id": 62,
                "cod_wallet_id": null,
                "shipment_external_id": null,
                "selected_shipment_company": null,
                "source": "manual",
                "return_type": null,
                "volumetric_divisor": null,
                "merchant_shipment_id": null,
                "return_ordered_at": null,
                "items": [
                    {
                        "id": 62503,
                        "order_id": 43977,
                        "name": null,
                        "sku": null,
                        "quantity": 1,
                        "weight": null,
                        "weight_unit": null,
                        "price": 0,
                        "total_price": 0,
                        "tax": null,
                        "currency": "SAR",
                        "created_at": "2026-01-04T18:39:05.000000Z",
                        "updated_at": "2026-01-04T18:39:05.000000Z",
                        "verification_status": "pending",
                        "verified_at": null,
                        "verified_by": null,
                        "wrong_attempts": 0,
                        "verification_note": null
                    }
                ],
                "boxes": [
                    {
                        "id": 33040,
                        "order_id": 43977,
                        "box_id": null,
                        "length": 10,
                        "width": 10,
                        "height": 10,
                        "weight": 10000,
                        "packaging_type_id": 1,
                        "created_at": "2026-01-04T18:39:05.000000Z",
                        "updated_at": "2026-01-04T18:39:05.000000Z"
                    }
                ]
            }
        ],
        "first_page_url": "http://localhost/api/orders?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://localhost/api/orders?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "http://localhost/api/orders?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://localhost/api/orders",
        "per_page": 2,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    }
}

Modified at 2025-12-29 12:36:58

Create Order

Order Details