Create warehouse

Create a new warehouse for the authenticated user by providing complete address, sender, and location details.

💡

Authentification

Bearer token authentication is required.

💡

short_address: Mandatory.
Must follow this format: 4 letters followed by 4 numbers.

📌

Auto Shipment Behavior

The user can enable automatic shipment creation by setting:

activate_auto_shipment = 1

the user must provide:

shipment_courier_service_id to select the courier company that will handle automatic shipments.

💡

Validation Rules

city_id must exist in the cities table.

shipment_courier_service_id must exist in shipment_courier_services table (if provided).

Email must be in a valid format.

All required address and sender fields must be provided.

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

Body Params application/jsonRequired

Examples

curl --location --request POST 'https://app.gotreek.com/api/warehouses' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "warehouseApiDog", "code": "1", "city_id": 7, "district": "Al-Rawdah", "street_name": "Prince Sultan Street", "building_no_name": "test", "address": "Abu Arish", "short_address": "RRRR2424", "zip_code": "48288", "sender_name": "ApiDog", "sender_email": "test@example.com", "sender_phone": "+966533113333", "status": 1, "activate_auto_shipment": 1, "shipment_courier_service_id": 3 }'

{ "success": true, "message": "Warehouse created successfully", "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" } } }

Request

Responses