Warehouses List

GET

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

Warehouses

Last modified:2025-12-25 15:41:26

List warehouses for the authenticated user with pagination, including basic location and owner information.

💡

Authentication

Bearer token authentication is required.

Only warehouses visible to the authenticated user are returned, according to your access control rules.

💡

Listing & pagination

Returns a paginated list of warehouses, ordered by creation date (newest first).

Each warehouse includes its basic fields (name, code, status, address, city ID) and related city and user information.

Use ?page= and ?per_page= to control pagination (maximum per_page is 100).

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

Responses

🟢200

application/json

Warehouses retrieved successfully

Body

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://app.gotreek.com/api/warehouses?page&per_page' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": [
        {
            "id": 1,
            "name": "مجمع لوجستي الشرق",
            "code": "PDF995",
            "address": "طريق الأمير محمد بن سلمان، حي الشفا",
            "sender_name": "خالد المطيري",
            "sender_email": "janelle07@mueller.com",
            "sender_phone": "966574187212",
            "status": 1,
            "city_id": 234,
            "district": "حي الملز",
            "street_name": "طريق الملك عبدالعزيز",
            "building_no_name": "مبنى رقم 445",
            "zip_code": "51283",
            "user_id": 26,
            "created_at": "2025-07-21T13:05:26Z",
            "updated_at": "2025-07-21T13:05:26Z",
            "city": {
                "id": 328,
                "name": "Riyadh",
                "name_ar": "الرياض",
                "country_id": 1
            },
            "user": {
                "id": 50,
                "first_name": "أحمد",
                "last_name": "محمد",
                "email": "ahmed.mohammed@example.com",
                "phone": "+966501234567"
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 5,
        "per_page": 15,
        "total": 75,
        "from": 1,
        "to": 15
    },
    "links": {
        "first": "http://localhost/api/boxes?page=1",
        "last": "http://localhost/api/boxes?page=5",
        "prev": null,
        "next": "http://localhost/api/boxes?page=2"
    }
}

Modified at 2025-12-25 15:41:26

Couriers List

Create warehouse