{ "info": { "name": "Alemdad Waltamween — API", "description": "Complete API collection auto-generated from Laravel routes, FormRequests, and middleware.\n\n## Response format\nAll endpoints return JSON:\n```json\n{ \"key\": \"success|fail|unauthenticated|blocked|needActive|needCompleteInfo\", \"msg\": \"...\", \"data\": {} }\n```\nValidation errors use `key=fail` with the first validation message (see `BaseRequest::failedValidation`).\n\n## Auth\n- User / Delegate / Shared chat: `Authorization: Bearer {{user_token}}` or `{{delegate_token}}` (Sanctum)\n- Provider: `Authorization: Bearer {{provider_token}}` (`auth:provider`)\n- Language header: `Lang: ar|en`\n\n## Variables\nSet `base_url` and tokens in the companion environment file.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_postman_id": "50dd29bb-e94a-4714-96a7-891ae6ecc7c7" }, "item": [ { "name": "Shared API", "item": [ { "name": "Chat", "item": [ { "name": "GET — Create Room", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-room" ] }, "description": "**Endpoint:** `GET /api/create-room`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Create Private Room", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-private-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-private-room" ] }, "description": "**Endpoint:** `POST /api/create-private-room`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Chat\\PrivateRoomRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `memberable_id` | `required\\|numeric` |\n| `memberable_type` | `required\\|in:User,Admin,Provider,Merchant,Delegate` |", "body": { "mode": "raw", "raw": "{\n \"memberable_id\": 1,\n \"memberable_type\": \"User\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-private-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-private-room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-private-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-private-room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The memberable_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-private-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-private-room" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The memberable_id field is required.\",\n \"errors\": {\n \"memberable_id\": [\n \"The memberable_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-private-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-private-room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/create-private-room", "host": [ "{{base_url}}" ], "path": [ "api", "create-private-room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Room Members", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/room-members/:room", "host": [ "{{base_url}}" ], "path": [ "api", "room-members", ":room" ], "variable": [ { "key": "room", "value": "1", "description": "Path parameter: room" } ] }, "description": "**Endpoint:** `GET /api/room-members/{room}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/room-members/:room", "host": [ "{{base_url}}" ], "path": [ "api", "room-members", ":room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/room-members/:room", "host": [ "{{base_url}}" ], "path": [ "api", "room-members", ":room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/room-members/:room", "host": [ "{{base_url}}" ], "path": [ "api", "room-members", ":room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/room-members/:room", "host": [ "{{base_url}}" ], "path": [ "api", "room-members", ":room" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Join Room", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/join-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "join-room", ":room" ], "variable": [ { "key": "room", "value": "1", "description": "Path parameter: room" } ] }, "description": "**Endpoint:** `GET /api/join-room/{room}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/join-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "join-room", ":room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/join-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "join-room", ":room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/join-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "join-room", ":room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/join-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "join-room", ":room" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Leave Room", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/leave-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "leave-room", ":room" ], "variable": [ { "key": "room", "value": "1", "description": "Path parameter: room" } ] }, "description": "**Endpoint:** `GET /api/leave-room/{room}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/leave-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "leave-room", ":room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/leave-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "leave-room", ":room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/leave-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "leave-room", ":room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/leave-room/:room", "host": [ "{{base_url}}" ], "path": [ "api", "leave-room", ":room" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Get Room Messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-messages", ":room" ], "variable": [ { "key": "room", "value": "1", "description": "Path parameter: room" } ] }, "description": "**Endpoint:** `GET /api/get-room-messages/{room}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-messages", ":room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-messages", ":room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-messages", ":room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-messages", ":room" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Get Room Unseen Messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-unseen-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-unseen-messages", ":room" ], "variable": [ { "key": "room", "value": "1", "description": "Path parameter: room" } ] }, "description": "**Endpoint:** `GET /api/get-room-unseen-messages/{room}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-unseen-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-unseen-messages", ":room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-unseen-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-unseen-messages", ":room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-unseen-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-unseen-messages", ":room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-room-unseen-messages/:room", "host": [ "{{base_url}}" ], "path": [ "api", "get-room-unseen-messages", ":room" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Get My Rooms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-rooms", "host": [ "{{base_url}}" ], "path": [ "api", "get-rooms" ] }, "description": "**Endpoint:** `GET /api/get-rooms`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-rooms", "host": [ "{{base_url}}" ], "path": [ "api", "get-rooms" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-rooms", "host": [ "{{base_url}}" ], "path": [ "api", "get-rooms" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-rooms", "host": [ "{{base_url}}" ], "path": [ "api", "get-rooms" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "DELETE — Delete Message Copy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delete-message-copy/:message", "host": [ "{{base_url}}" ], "path": [ "api", "delete-message-copy", ":message" ], "variable": [ { "key": "message", "value": "1", "description": "Path parameter: message" } ] }, "description": "**Endpoint:** `DELETE /api/delete-message-copy/{message}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delete-message-copy/:message", "host": [ "{{base_url}}" ], "path": [ "api", "delete-message-copy", ":message" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delete-message-copy/:message", "host": [ "{{base_url}}" ], "path": [ "api", "delete-message-copy", ":message" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delete-message-copy/:message", "host": [ "{{base_url}}" ], "path": [ "api", "delete-message-copy", ":message" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delete-message-copy/:message", "host": [ "{{base_url}}" ], "path": [ "api", "delete-message-copy", ":message" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Send Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-message/:room", "host": [ "{{base_url}}" ], "path": [ "api", "send-message", ":room" ], "variable": [ { "key": "room", "value": "1", "description": "Path parameter: room" } ] }, "description": "**Endpoint:** `POST /api/send-message/{room}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-message/:room", "host": [ "{{base_url}}" ], "path": [ "api", "send-message", ":room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-message/:room", "host": [ "{{base_url}}" ], "path": [ "api", "send-message", ":room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-message/:room", "host": [ "{{base_url}}" ], "path": [ "api", "send-message", ":room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-message/:room", "host": [ "{{base_url}}" ], "path": [ "api", "send-message", ":room" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Upload Room File", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/upload-room-file/:room", "host": [ "{{base_url}}" ], "path": [ "api", "upload-room-file", ":room" ], "variable": [ { "key": "room", "value": "1", "description": "Path parameter: room" } ] }, "description": "**Endpoint:** `POST /api/upload-room-file/{room}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/upload-room-file/:room", "host": [ "{{base_url}}" ], "path": [ "api", "upload-room-file", ":room" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/upload-room-file/:room", "host": [ "{{base_url}}" ], "path": [ "api", "upload-room-file", ":room" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/upload-room-file/:room", "host": [ "{{base_url}}" ], "path": [ "api", "upload-room-file", ":room" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/upload-room-file/:room", "host": [ "{{base_url}}" ], "path": [ "api", "upload-room-file", ":room" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Shared API — Chat" }, { "name": "Contact Messages", "item": [ { "name": "POST — Store Contact Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "send-contact-message" ] }, "description": "**Endpoint:** `POST /api/send-contact-message`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\ContactMessage\\ContactMessageRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `name` | `required\\|min:3\\|max:50` |\n| `country_code` | `required\\|numeric\\|digits:3` |\n| `phone` | `required\\|numeric\\|digits_between:9,10` |\n| `subject` | `required\\|min:10\\|max:5000` |\n| `title` | `nullable` |\n| `image` | `nullable\\|image\\|mimes:jpeg,jpg,png,webp\\|max:2048` |\n| `contactable_id` | `nullable` |\n| `contactable_type` | `nullable` |", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Ahmed Ali", "type": "text", "description": "Required" }, { "key": "country_code", "value": "966", "type": "text", "description": "Required" }, { "key": "phone", "value": "512345678", "type": "text", "description": "Required" }, { "key": "subject", "value": "example", "type": "text", "description": "Required" }, { "key": "title", "value": "Golden Ring", "type": "text", "description": "Optional" }, { "key": "image", "type": "file", "src": [], "description": "Optional file" }, { "key": "contactable_id", "value": "1", "type": "text", "description": "Optional" }, { "key": "contactable_type", "value": "example", "type": "text", "description": "Optional" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "send-contact-message" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "send-contact-message" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "send-contact-message" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] } ], "description": "Shared API — Contact Messages" }, { "name": "FAQs", "item": [ { "name": "GET — Get Fqss", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-fqss", "host": [ "{{base_url}}" ], "path": [ "api", "get-fqss" ] }, "description": "**Endpoint:** `GET /api/get-fqss`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/get-fqss", "host": [ "{{base_url}}" ], "path": [ "api", "get-fqss" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Example\"\n }\n ]\n}" } ] } ], "description": "Shared API — FAQs" }, { "name": "Geo Lookups", "item": [ { "name": "GET — Countries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/countries", "host": [ "{{base_url}}" ], "path": [ "api", "countries" ] }, "description": "**Endpoint:** `GET /api/countries`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/countries", "host": [ "{{base_url}}" ], "path": [ "api", "countries" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Example\"\n }\n ]\n}" } ] }, { "name": "GET — Cities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/cities", "host": [ "{{base_url}}" ], "path": [ "api", "cities" ] }, "description": "**Endpoint:** `GET /api/cities`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/cities", "host": [ "{{base_url}}" ], "path": [ "api", "cities" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Example\"\n }\n ]\n}" } ] }, { "name": "GET — Cities With Pagination", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/cities-with-pagination", "host": [ "{{base_url}}" ], "path": [ "api", "cities-with-pagination" ] }, "description": "**Endpoint:** `GET /api/cities-with-pagination`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/cities-with-pagination", "host": [ "{{base_url}}" ], "path": [ "api", "cities-with-pagination" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Example\"\n }\n ]\n}" } ] }, { "name": "GET — Country Keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/country-keys", "host": [ "{{base_url}}" ], "path": [ "api", "country-keys" ] }, "description": "**Endpoint:** `GET /api/country-keys`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/country-keys", "host": [ "{{base_url}}" ], "path": [ "api", "country-keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] }, { "name": "GET — Districts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/districts", "host": [ "{{base_url}}" ], "path": [ "api", "districts" ] }, "description": "**Endpoint:** `GET /api/districts`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/districts", "host": [ "{{base_url}}" ], "path": [ "api", "districts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Example\"\n }\n ]\n}" } ] }, { "name": "GET — City Districts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/city-districts/:city_id", "host": [ "{{base_url}}" ], "path": [ "api", "city-districts", ":city_id" ], "variable": [ { "key": "city_id", "value": "1", "description": "Path parameter: city_id" } ] }, "description": "**Endpoint:** `GET /api/city-districts/{city_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/city-districts/:city_id", "host": [ "{{base_url}}" ], "path": [ "api", "city-districts", ":city_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/city-districts/:city_id", "host": [ "{{base_url}}" ], "path": [ "api", "city-districts", ":city_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Shared API — Geo Lookups" }, { "name": "Measurements", "item": [ { "name": "GET — Measurements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/measurements", "host": [ "{{base_url}}" ], "path": [ "api", "measurements" ] }, "description": "**Endpoint:** `GET /api/measurements`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/measurements", "host": [ "{{base_url}}" ], "path": [ "api", "measurements" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Example\"\n }\n ]\n}" } ] } ], "description": "Shared API — Measurements" }, { "name": "Pages", "item": [ { "name": "GET — Contact Us Data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/contact-us-data", "host": [ "{{base_url}}" ], "path": [ "api", "contact-us-data" ] }, "description": "**Endpoint:** `GET /api/contact-us-data`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/contact-us-data", "host": [ "{{base_url}}" ], "path": [ "api", "contact-us-data" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"title\": \"Page title\",\n \"content\": \"Page HTML\\/content\"\n }\n}" } ] }, { "name": "GET — Terms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/terms", "host": [ "{{base_url}}" ], "path": [ "api", "terms" ] }, "description": "**Endpoint:** `GET /api/terms`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/terms", "host": [ "{{base_url}}" ], "path": [ "api", "terms" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"title\": \"Page title\",\n \"content\": \"Page HTML\\/content\"\n }\n}" } ] }, { "name": "GET — Privacy", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/privacy", "host": [ "{{base_url}}" ], "path": [ "api", "privacy" ] }, "description": "**Endpoint:** `GET /api/privacy`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/privacy", "host": [ "{{base_url}}" ], "path": [ "api", "privacy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"title\": \"Page title\",\n \"content\": \"Page HTML\\/content\"\n }\n}" } ] }, { "name": "GET — About", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/about", "host": [ "{{base_url}}" ], "path": [ "api", "about" ] }, "description": "**Endpoint:** `GET /api/about`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/about", "host": [ "{{base_url}}" ], "path": [ "api", "about" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"title\": \"Page title\",\n \"content\": \"Page HTML\\/content\"\n }\n}" } ] }, { "name": "GET — Return Order Terms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/return-order-terms", "host": [ "{{base_url}}" ], "path": [ "api", "return-order-terms" ] }, "description": "**Endpoint:** `GET /api/return-order-terms`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/return-order-terms", "host": [ "{{base_url}}" ], "path": [ "api", "return-order-terms" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"title\": \"Page title\",\n \"content\": \"Page HTML\\/content\"\n }\n}" } ] } ], "description": "Shared API — Pages" }, { "name": "Socials", "item": [ { "name": "GET — Socials", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/socials", "host": [ "{{base_url}}" ], "path": [ "api", "socials" ] }, "description": "**Endpoint:** `GET /api/socials`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/socials", "host": [ "{{base_url}}" ], "path": [ "api", "socials" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Example\"\n }\n ]\n}" } ] } ], "description": "Shared API — Socials" } ], "description": "Shared endpoints under `/api` (pages, geo, FAQs, chat, etc.). Prefix: `{{base_url}}/api`" }, { "name": "User API", "item": [ { "name": "Authentication", "item": [ { "name": "POST — Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-in" ] }, "description": "**Endpoint:** `POST /api/user/sign-in`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Auth\\LoginRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10` |\n| `password` | `required\\|string\\|max:100` |\n| `device_id` | `required\\|max:250` |\n| `device_type` | `in:ios,android,web` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"password\": \"Password@123\",\n \"device_id\": \"device-uuid-12345\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-in" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Ahmed Ali\",\n \"email\": \"user@example.com\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"full_phone\": \"966512345678\",\n \"city_id\": 1,\n \"city_name\": \"Riyadh\",\n \"commercial_number\": \"1234567890\",\n \"lat\": \"24.7136\",\n \"lng\": \"46.6753\",\n \"map_desc\": \"Riyadh\",\n \"is_notify\": true,\n \"balance\": 0,\n \"image\": \"https:\\/\\/example.com\\/storage\\/users\\/default.png\",\n \"token\": \"1|laravel_sanctum_token_example\"\n }\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-in" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The country_code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-in" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The country_code field is required.\",\n \"errors\": {\n \"country_code\": [\n \"The country_code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Need Active (203)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-in" ] } }, "status": "Non-Authoritative Information", "code": 203, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"needActive\",\n \"msg\": \"Account not activated\",\n \"data\": {\n \"phone\": \"512345678\",\n \"country_code\": \"966\"\n }\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "try {", " const res = pm.response.json();", " const token = res?.data?.token;", " if (token) {", " pm.collectionVariables.set('user_token', token);", " pm.environment.set('user_token', token);", " console.log('Saved user_token');", " }", "} catch (e) { console.warn(e); }" ] } } ] }, { "name": "POST — Register", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-up", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-up" ] }, "description": "**Endpoint:** `POST /api/user/sign-up`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Auth\\RegisterRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `name` | `required\\|string\\|min:2\\|max:50` |\n| `country_code` | `required\\|numeric\\|digits_between:2,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|unique:users,phone,NULL,id,deleted_at,NULL` |\n| `email` | `nullable\\|email\\|max:50\\|unique:users,email,NULL,id,deleted_at,NULL` |\n| `city_id` | `nullable\\|integer\\|exists:cities,id` |\n| `commercial_number` | `required\\|numeric\\|digits_between:10,20\\|unique:users,commercial_number,NULL,id,deleted_at,NULL` |\n| `mac_address` | `nullable\\|max:250` |", "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Ali\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"email\": \"user@example.com\",\n \"city_id\": 1,\n \"commercial_number\": \"1234567890\",\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-up", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-up" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"phone\": \"512345678\",\n \"country_code\": \"966\"\n }\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-up", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-up" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/sign-up", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-up" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "PATCH — Resend Code", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "resend-code" ] }, "description": "**Endpoint:** `PATCH /api/user/resend-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Auth\\ResendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|exists:users,phone,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "resend-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "resend-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The country_code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "resend-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The country_code field is required.\",\n \"errors\": {\n \"country_code\": [\n \"The country_code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Forget Password Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/forget-password-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "forget-password-send-code" ] }, "description": "**Endpoint:** `POST /api/user/forget-password-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\ForgetPassword\\ForgetPasswordSendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|exists:users,phone,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/forget-password-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "forget-password-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/forget-password-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "forget-password-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The country_code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/forget-password-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "forget-password-send-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The country_code field is required.\",\n \"errors\": {\n \"country_code\": [\n \"The country_code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Forget Password Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/forget-password-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "forget-password-check-code" ] }, "description": "**Endpoint:** `POST /api/user/forget-password-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\ForgetPassword\\ForgetPasswordCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|max:10` |\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|exists:users,phone,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/forget-password-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "forget-password-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/forget-password-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "forget-password-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/forget-password-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "forget-password-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "reset-password" ] }, "description": "**Endpoint:** `POST /api/user/reset-password`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\ForgetPassword\\ResetPasswordCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|max:10` |\n| `country_code` | `required\\|exists:users,country_code` |\n| `phone` | `required\\|exists:users,phone` |\n| `password` | `required\\|confirmed\\|min:6\\|max:100` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"password\": \"Password@123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "reset-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "reset-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/user/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "reset-password" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Complete Info", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complete-info" ] }, "description": "**Endpoint:** `POST /api/user/complete-info`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Auth\\CompleteInfoRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `user` | `required` |\n| `lat` | `required\\|max:50` |\n| `lng` | `required\\|max:50` |\n| `map_desc` | `required\\|max:191` |\n| `device_id` | `required\\|max:250` |\n| `device_type` | `in:ios,android,web` |", "body": { "mode": "raw", "raw": "{\n \"lat\": 24.7135999999999995679900166578590869903564453125,\n \"lng\": 46.67530000000000001136868377216160297393798828125,\n \"map_desc\": \"Riyadh, Saudi Arabia\",\n \"device_id\": \"device-uuid-12345\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complete-info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complete-info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The user field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complete-info" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The user field is required.\",\n \"errors\": {\n \"user\": [\n \"The user field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complete-info" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complete-info" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PATCH — Activate", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/activate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "activate" ] }, "description": "**Endpoint:** `PATCH /api/user/activate`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Auth\\ActivateRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|max:10` |\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|exists:users,phone,deleted_at,NULL` |\n| `device_id` | `required\\|max:250` |\n| `device_type` | `in:ios,android,web` |\n| `mac_address` | `nullable\\|max:250` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"device_id\": \"device-uuid-12345\",\n \"device_type\": \"ios\",\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/activate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Ahmed Ali\",\n \"email\": \"user@example.com\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"full_phone\": \"966512345678\",\n \"city_id\": 1,\n \"city_name\": \"Riyadh\",\n \"commercial_number\": \"1234567890\",\n \"lat\": \"24.7136\",\n \"lng\": \"46.6753\",\n \"map_desc\": \"Riyadh\",\n \"is_notify\": true,\n \"balance\": 0,\n \"image\": \"https:\\/\\/example.com\\/storage\\/users\\/default.png\",\n \"token\": \"1|laravel_sanctum_token_example\"\n }\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/activate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/activate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "activate" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/activate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "activate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/activate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "activate" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Need Active (203)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/activate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "activate" ] } }, "status": "Non-Authoritative Information", "code": 203, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"needActive\",\n \"msg\": \"Account not activated\",\n \"data\": {\n \"phone\": \"512345678\",\n \"country_code\": \"966\"\n }\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "try {", " const res = pm.response.json();", " const token = res?.data?.token;", " if (token) {", " pm.collectionVariables.set('user_token', token);", " pm.environment.set('user_token', token);", " console.log('Saved user_token');", " }", "} catch (e) { console.warn(e); }" ] } } ] }, { "name": "DELETE — Logout", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-out" ] }, "description": "**Endpoint:** `DELETE /api/user/sign-out`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-out" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-out" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sign-out" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Delete Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-account", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-account" ] }, "description": "**Endpoint:** `POST /api/user/delete-account`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-account", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-account", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-account" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-account", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-account" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "User API — Authentication" }, { "name": "Cart", "item": [ { "name": "GET — Count Cart", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/count-cart?mac_address=AA%3ABB%3ACC%3ADD%3AEE%3AFF&owner_type=user_id&owner=1", "host": [ "{{base_url}}" ], "path": [ "api", "user", "count-cart" ], "query": [ { "key": "mac_address", "value": "AA:BB:CC:DD:EE:FF", "description": "Required" }, { "key": "owner_type", "value": "user_id", "description": "Required" }, { "key": "owner", "value": "1", "description": "Required" } ] }, "description": "**Endpoint:** `GET /api/user/count-cart`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Cart\\CountCartRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `owner_type` | `required` |\n| `owner` | `required` |" }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/count-cart?mac_address=AA%3ABB%3ACC%3ADD%3AEE%3AFF&owner_type=user_id&owner=1", "host": [ "{{base_url}}" ], "path": [ "api", "user", "count-cart" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"count\": 2\n }\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/count-cart?mac_address=AA%3ABB%3ACC%3ADD%3AEE%3AFF&owner_type=user_id&owner=1", "host": [ "{{base_url}}" ], "path": [ "api", "user", "count-cart" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The mac_address field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/count-cart?mac_address=AA%3ABB%3ACC%3ADD%3AEE%3AFF&owner_type=user_id&owner=1", "host": [ "{{base_url}}" ], "path": [ "api", "user", "count-cart" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The mac_address field is required.\",\n \"errors\": {\n \"mac_address\": [\n \"The mac_address field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Add Update Cart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/add-update-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "add-update-cart" ] }, "description": "**Endpoint:** `POST /api/user/add-update-cart`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Cart\\AddUpdateCartRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `product_id` | `required\\|integer\\|exists:products,id` |\n| `qty` | `required\\|numeric\\|min:1` |\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `owner_type` | `required` |\n| `owner` | `required` |", "body": { "mode": "raw", "raw": "{\n \"product_id\": 1,\n \"qty\": 1,\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/add-update-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "add-update-cart" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/add-update-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "add-update-cart" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The product_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/add-update-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "add-update-cart" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The product_id field is required.\",\n \"errors\": {\n \"product_id\": [\n \"The product_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "GET — Show Cart", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/show-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "show-cart" ] }, "description": "**Endpoint:** `GET /api/user/show-cart`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/show-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "show-cart" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] }, { "name": "POST — Delete Provider", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-cart-provider", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-cart-provider" ] }, "description": "**Endpoint:** `POST /api/user/delete-cart-provider`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Cart\\DeleteCartProviderRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `provider_id` | `required\\|exists:providers,id` |\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `owner_type` | `required` |\n| `owner` | `required` |", "body": { "mode": "raw", "raw": "{\n \"provider_id\": 1,\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-cart-provider", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-cart-provider" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-cart-provider", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-cart-provider" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The provider_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-cart-provider", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-cart-provider" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The provider_id field is required.\",\n \"errors\": {\n \"provider_id\": [\n \"The provider_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Delete Cart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-cart" ] }, "description": "**Endpoint:** `POST /api/user/delete-cart`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Cart\\DeleteCartRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `cart_id` | `required\\|exists:carts,id` |\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `owner_type` | `required` |\n| `owner` | `required` |", "body": { "mode": "raw", "raw": "{\n \"cart_id\": 1,\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-cart" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-cart" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The cart_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-cart", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-cart" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The cart_id field is required.\",\n \"errors\": {\n \"cart_id\": [\n \"The cart_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Cart Inquiry", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cart-inquiry", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cart-inquiry" ] }, "description": "**Endpoint:** `POST /api/user/cart-inquiry`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Cart\\CartInquiryRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `owner_type` | `required` |\n| `owner` | `required` |\n| `location_id` | `nullable\\|exists:user_locations,id` |\n| `provider_id` | `required\\|exists:providers,id` |\n| `coupon_num` | `nullable\\|exists:coupons,coupon_num` |\n| `pay_type` | `nullable\\|in:0,1,2` |\n| `use_wallet_balance` | `required_if:pay_type,2\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\",\n \"location_id\": 1,\n \"provider_id\": 1,\n \"coupon_num\": \"SAVE10\",\n \"pay_type\": \"0\",\n \"use_wallet_balance\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cart-inquiry", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cart-inquiry" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cart-inquiry", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cart-inquiry" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The mac_address field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cart-inquiry", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cart-inquiry" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The mac_address field is required.\",\n \"errors\": {\n \"mac_address\": [\n \"The mac_address field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] } ], "description": "User API — Cart" }, { "name": "Categories", "item": [ { "name": "GET — Sub Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sub-categories/:category_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sub-categories", ":category_id" ], "variable": [ { "key": "category_id", "value": "1", "description": "Path parameter: category_id" } ] }, "description": "**Endpoint:** `GET /api/user/sub-categories/{category_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sub-categories/:category_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sub-categories", ":category_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sub-categories/:category_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sub-categories", ":category_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "User API — Categories" }, { "name": "Complaints", "item": [ { "name": "GET — Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints" ] }, "description": "**Endpoint:** `GET /api/user/complaints`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Store Complaint", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "store" ] }, "description": "**Endpoint:** `POST /api/user/complaints/store`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Complaint\\StoreComplaintRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `type` | `required\\|in:inquiry,complaint,suggestion` |\n| `subject` | `sometimes\\|max:50` |\n| `email` | `sometimes\\|email\\|max:50` |\n| `complaint` | `required\\|max:500` |\n| `images` | `nullable\\|array` |\n| `images.*` | `nullable\\|file` |", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "inquiry", "type": "text", "description": "Required" }, { "key": "subject", "value": "example", "type": "text", "description": "Optional" }, { "key": "email", "value": "user@example.com", "type": "text", "description": "Optional" }, { "key": "complaint", "value": "Issue with delivery", "type": "text", "description": "Required" }, { "key": "images[0]", "type": "file", "src": [], "description": "Optional file" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The type field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "store" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The type field is required.\",\n \"errors\": {\n \"type\": [\n \"The type field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "store" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "store" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "show", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/complaints/show/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "show", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "show", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "show", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "complaints", "show", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "User API — Complaints" }, { "name": "Diff / Compare", "item": [ { "name": "GET — Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/diff-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "diff-products" ] }, "description": "**Endpoint:** `GET /api/user/diff-products`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/diff-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "diff-products" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/diff-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "diff-products" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/diff-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "diff-products" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Toggle", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-diff-product", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-diff-product" ] }, "description": "**Endpoint:** `POST /api/user/toggle-diff-product`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Product\\ToggleDiffRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `product_id` | `required\\|exists:products,id` |", "body": { "mode": "raw", "raw": "{\n \"product_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-diff-product", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-diff-product" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-diff-product", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-diff-product" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The product_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-diff-product", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-diff-product" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The product_id field is required.\",\n \"errors\": {\n \"product_id\": [\n \"The product_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-diff-product", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-diff-product" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-diff-product", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-diff-product" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "DELETE — Clear", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/clear-diff-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "clear-diff-products" ] }, "description": "**Endpoint:** `DELETE /api/user/clear-diff-products`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/clear-diff-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "clear-diff-products" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/clear-diff-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "clear-diff-products" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/clear-diff-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "clear-diff-products" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "User API — Diff / Compare" }, { "name": "Favorites", "item": [ { "name": "POST — Add To Fav", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/add-to-fav", "host": [ "{{base_url}}" ], "path": [ "api", "user", "add-to-fav" ] }, "description": "**Endpoint:** `POST /api/user/add-to-fav`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Product\\AddToFavRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `provider_id` | `required\\|exists:providers,id` |\n| `owner_type` | `required` |\n| `owner` | `required` |", "body": { "mode": "raw", "raw": "{\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\",\n \"provider_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/add-to-fav", "host": [ "{{base_url}}" ], "path": [ "api", "user", "add-to-fav" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/add-to-fav", "host": [ "{{base_url}}" ], "path": [ "api", "user", "add-to-fav" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The mac_address field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/add-to-fav", "host": [ "{{base_url}}" ], "path": [ "api", "user", "add-to-fav" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The mac_address field is required.\",\n \"errors\": {\n \"mac_address\": [\n \"The mac_address field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Remove From Fav", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/remove-from-fav", "host": [ "{{base_url}}" ], "path": [ "api", "user", "remove-from-fav" ] }, "description": "**Endpoint:** `POST /api/user/remove-from-fav`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Product\\RemoveFromFavRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `provider_id` | `required\\|exists:providers,id` |\n| `owner_type` | `required` |\n| `owner` | `required` |", "body": { "mode": "raw", "raw": "{\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\",\n \"provider_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/remove-from-fav", "host": [ "{{base_url}}" ], "path": [ "api", "user", "remove-from-fav" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/remove-from-fav", "host": [ "{{base_url}}" ], "path": [ "api", "user", "remove-from-fav" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The mac_address field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/remove-from-fav", "host": [ "{{base_url}}" ], "path": [ "api", "user", "remove-from-fav" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The mac_address field is required.\",\n \"errors\": {\n \"mac_address\": [\n \"The mac_address field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Toggle Favorite", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-favorite", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-favorite" ] }, "description": "**Endpoint:** `POST /api/user/toggle-favorite`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Product\\ToggleFavoriteRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `provider_id` | `required\\|exists:providers,id` |\n| `owner_type` | `required` |\n| `owner` | `required` |", "body": { "mode": "raw", "raw": "{\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\",\n \"provider_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-favorite", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-favorite" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-favorite", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-favorite" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The mac_address field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/toggle-favorite", "host": [ "{{base_url}}" ], "path": [ "api", "user", "toggle-favorite" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The mac_address field is required.\",\n \"errors\": {\n \"mac_address\": [\n \"The mac_address field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "GET — Get Favorites", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/favorites", "host": [ "{{base_url}}" ], "path": [ "api", "user", "favorites" ] }, "description": "**Endpoint:** `GET /api/user/favorites`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/favorites", "host": [ "{{base_url}}" ], "path": [ "api", "user", "favorites" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] } ], "description": "User API — Favorites" }, { "name": "Home", "item": [ { "name": "GET — App Home Page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/home", "host": [ "{{base_url}}" ], "path": [ "api", "user", "home" ] }, "description": "**Endpoint:** `GET /api/user/home`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/home", "host": [ "{{base_url}}" ], "path": [ "api", "user", "home" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] }, { "name": "GET — App Home Providers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/home/providers", "host": [ "{{base_url}}" ], "path": [ "api", "user", "home", "providers" ] }, "description": "**Endpoint:** `GET /api/user/home/providers`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/home/providers", "host": [ "{{base_url}}" ], "path": [ "api", "user", "home", "providers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] }, { "name": "GET — App Home Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/home/categories", "host": [ "{{base_url}}" ], "path": [ "api", "user", "home", "categories" ] }, "description": "**Endpoint:** `GET /api/user/home/categories`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/home/categories", "host": [ "{{base_url}}" ], "path": [ "api", "user", "home", "categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] } ], "description": "User API — Home" }, { "name": "Locations", "item": [ { "name": "GET — Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations" ] }, "description": "**Endpoint:** `GET /api/user/locations`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Show Location", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/locations/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/locations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "locations", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Store Location", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/store-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "store-location" ] }, "description": "**Endpoint:** `POST /api/user/store-location`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Locaion\\StoreLocationRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `name` | `required\\|string\\|max:50` |\n| `city_id` | `required\\|exists:cities,id` |\n| `district_id` | `required\\|exists:districts,id` |\n| `street` | `required\\|string\\|max:150` |\n| `building_number` | `required\\|string\\|max:20` |\n| `apartment_number` | `nullable\\|string\\|max:20` |\n| `national_address` | `required\\|string\\|max:255` |\n| `notes` | `nullable\\|string\\|max:500` |", "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Ali\",\n \"city_id\": 1,\n \"district_id\": 1,\n \"street\": \"King Fahd Road\",\n \"building_number\": \"example\",\n \"apartment_number\": \"example\",\n \"national_address\": \"example\",\n \"notes\": \"example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/store-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "store-location" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/store-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "store-location" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/store-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "store-location" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/store-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "store-location" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/store-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "store-location" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Update Location", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-location/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-location", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/user/update-location/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Locaion\\UpdateLocationRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `name` | `required\\|string\\|max:50` |\n| `city_id` | `required\\|exists:cities,id` |\n| `district_id` | `required\\|exists:districts,id` |\n| `street` | `required\\|string\\|max:150` |\n| `building_number` | `required\\|string\\|max:20` |\n| `apartment_number` | `nullable\\|string\\|max:20` |\n| `national_address` | `required\\|string\\|max:255` |\n| `notes` | `nullable\\|string\\|max:500` |", "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Ali\",\n \"city_id\": 1,\n \"district_id\": 1,\n \"street\": \"King Fahd Road\",\n \"building_number\": \"example\",\n \"apartment_number\": \"example\",\n \"national_address\": \"example\",\n \"notes\": \"example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-location/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-location", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-location/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-location", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-location/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-location", ":id" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-location/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-location", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-location/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-location", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-location/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-location", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "DELETE — Delete Location", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-location/:location_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-location", ":location_id" ], "variable": [ { "key": "location_id", "value": "1", "description": "Path parameter: location_id" } ] }, "description": "**Endpoint:** `DELETE /api/user/delete-location/{location_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-location/:location_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-location", ":location_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-location/:location_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-location", ":location_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-location/:location_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-location", ":location_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-location/:location_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-location", ":location_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Change Default Location", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-default-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-default-location" ] }, "description": "**Endpoint:** `POST /api/user/change-default-location`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Locaion\\ChangeDefaultLocationRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `location_id` | `required\\|exists:user_locations,id` |", "body": { "mode": "raw", "raw": "{\n \"location_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-default-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-default-location" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-default-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-default-location" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The location_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-default-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-default-location" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The location_id field is required.\",\n \"errors\": {\n \"location_id\": [\n \"The location_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-default-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-default-location" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-default-location", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-default-location" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "User API — Locations" }, { "name": "Notifications", "item": [ { "name": "PATCH — Switch Notification Status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "user", "switch-notify" ] }, "description": "**Endpoint:** `PATCH /api/user/switch-notify`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "user", "switch-notify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "user", "switch-notify" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "user", "switch-notify" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Notifications With Limit", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "user", "notifications-with-limit" ] }, "description": "**Endpoint:** `GET /api/user/notifications-with-limit`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "user", "notifications-with-limit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "user", "notifications-with-limit" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "user", "notifications-with-limit" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "notifications" ] }, "description": "**Endpoint:** `GET /api/user/notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Count Unread Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "count-notifications" ] }, "description": "**Endpoint:** `GET /api/user/count-notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "count-notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"count\": 3\n }\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "count-notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "count-notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "DELETE — Delete Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notification", ":notification_id" ], "variable": [ { "key": "notification_id", "value": "1", "description": "Path parameter: notification_id" } ] }, "description": "**Endpoint:** `DELETE /api/user/delete-notification/{notification_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notification", ":notification_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notification", ":notification_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notification", ":notification_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notification", ":notification_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "DELETE — Delete Notifications", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notifications" ] }, "description": "**Endpoint:** `DELETE /api/user/delete-notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "user", "delete-notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "User API — Notifications" }, { "name": "Order", "item": [ { "name": "Normal", "item": [ { "name": "POST — Create Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-order" ] }, "description": "**Endpoint:** `POST /api/user/create-order`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Order\\CreateOrderRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `pay_type` | `required\\|in:0,1,2` |\n| `delivery_type` | `nullable\\|in:delivery,pickup` |\n| `coupon_num` | `nullable\\|exists:coupons,coupon_num` |\n| `owner_type` | `required` |\n| `owner` | `required` |\n| `provider` | `nullable` |\n| `needs_redirect_url` | `nullable\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"pay_type\": \"0\",\n \"delivery_type\": \"delivery\",\n \"coupon_num\": \"SAVE10\",\n \"needs_redirect_url\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The pay_type field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-order" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The pay_type field is required.\",\n \"errors\": {\n \"pay_type\": [\n \"The pay_type field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-order" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-order" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — New Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/new-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "new-orders" ] }, "description": "**Endpoint:** `GET /api/user/new-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/new-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "new-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/new-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "new-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/new-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "new-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Current Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/current-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "current-orders" ] }, "description": "**Endpoint:** `GET /api/user/current-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/current-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "current-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/current-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "current-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/current-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "current-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Finished Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finished-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finished-orders" ] }, "description": "**Endpoint:** `GET /api/user/finished-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finished-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finished-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finished-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finished-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finished-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finished-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Cancelled Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cancelled-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cancelled-orders" ] }, "description": "**Endpoint:** `GET /api/user/cancelled-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cancelled-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cancelled-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cancelled-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cancelled-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cancelled-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cancelled-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Order Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "order-details", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/order-details/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "order-details", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "order-details", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "order-details", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "order-details", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Cancel Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cancel-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cancel-order" ] }, "description": "**Endpoint:** `POST /api/user/cancel-order`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cancel-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cancel-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cancel-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cancel-order" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/cancel-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "cancel-order" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Finish Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finish-order/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finish-order", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/user/finish-order/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finish-order/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finish-order", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finish-order/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finish-order", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finish-order/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finish-order", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finish-order/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finish-order", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Rate Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rate-order" ] }, "description": "**Endpoint:** `POST /api/user/rate-order`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Order\\RateOrderRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `order_id` | `required\\|exists:orders,id` |\n| `provider_id` | `required\\|exists:providers,id` |\n| `provider_rate` | `required\\|numeric\\|min:1\\|max:5` |\n| `provider_comment` | `required\\|max:191` |\n| `products` | `required\\|array` |\n| `products.*.id` | `required\\|exists:products,id` |\n| `products.*.rate` | `required\\|numeric\\|min:1\\|max:5` |\n| `products.*.comment` | `required\\|max:191` |", "body": { "mode": "raw", "raw": "{\n \"order_id\": 1,\n \"provider_id\": 1,\n \"provider_rate\": 1,\n \"provider_comment\": \"example\",\n \"products\": [\n {\n \"id\": \"example\",\n \"rate\": 5,\n \"comment\": \"Great service\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rate-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rate-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The order_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rate-order" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The order_id field is required.\",\n \"errors\": {\n \"order_id\": [\n \"The order_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rate-order" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rate-order" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "User API — Order / Normal" }, { "name": "Retrieval", "item": [ { "name": "POST — Create Return Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-return-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-return-order" ] }, "description": "**Endpoint:** `POST /api/user/create-return-order`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Order\\CreateReturnOrderRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `order_id` | `required\\|exists:orders,id,user_id,` |\n| `images` | `array` |\n| `images.*` | `required\\|image` |\n| `return_reason` | `required\\|string\\|max:191` |\n| `products_ids` | `required\\|array` |\n| `products_ids.*.id` | `required\\|exists:products,id\\|exists:order_items,product_id,order_id,` |\n| `products_ids.*.qty` | `required\\|numeric\\|min:1` |", "body": { "mode": "formdata", "formdata": [ { "key": "order_id", "value": "1", "type": "text", "description": "Required" }, { "key": "return_reason", "value": "example", "type": "text", "description": "Required" }, { "key": "products_ids", "value": "[]", "type": "text", "description": "Required" }, { "key": "images[0]", "type": "file", "src": [], "description": "Required file" }, { "key": "products_ids[0][id]", "value": "1", "type": "text", "description": "Required" }, { "key": "products_ids[0][qty]", "value": "1", "type": "text", "description": "Required" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-return-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-return-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-return-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-return-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The order_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-return-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-return-order" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The order_id field is required.\",\n \"errors\": {\n \"order_id\": [\n \"The order_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-return-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-return-order" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/create-return-order", "host": [ "{{base_url}}" ], "path": [ "api", "user", "create-return-order" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — New Return Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/new-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "new-return-orders" ] }, "description": "**Endpoint:** `GET /api/user/new-return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/new-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "new-return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/new-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "new-return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/new-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "new-return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Current Return Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/current-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "current-return-orders" ] }, "description": "**Endpoint:** `GET /api/user/current-return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/current-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "current-return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/current-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "current-return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/current-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "current-return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Finished Return Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finished-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finished-return-orders" ] }, "description": "**Endpoint:** `GET /api/user/finished-return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finished-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finished-return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finished-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finished-return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/finished-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "finished-return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Rejected Return Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rejected-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rejected-return-orders" ] }, "description": "**Endpoint:** `GET /api/user/rejected-return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rejected-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rejected-return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rejected-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rejected-return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/rejected-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "rejected-return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Return Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-orders" ] }, "description": "**Endpoint:** `GET /api/user/return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Order Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-order-details", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/return-order-details/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-order-details", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-order-details", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-order-details", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/return-order-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "return-order-details", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "User API — Order / Retrieval" }, { "name": "Special", "item": [ { "name": "POST — Map Location Tracking", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/map_location_tracking", "host": [ "{{base_url}}" ], "path": [ "api", "user", "map_location_tracking" ] }, "description": "**Endpoint:** `POST /api/user/map_location_tracking`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Order\\MapLocationTrackingRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `order_id` | `required\\|integer` |", "body": { "mode": "raw", "raw": "{\n \"order_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/map_location_tracking", "host": [ "{{base_url}}" ], "path": [ "api", "user", "map_location_tracking" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/map_location_tracking", "host": [ "{{base_url}}" ], "path": [ "api", "user", "map_location_tracking" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The order_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/map_location_tracking", "host": [ "{{base_url}}" ], "path": [ "api", "user", "map_location_tracking" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The order_id field is required.\",\n \"errors\": {\n \"order_id\": [\n \"The order_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/map_location_tracking", "host": [ "{{base_url}}" ], "path": [ "api", "user", "map_location_tracking" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/map_location_tracking", "host": [ "{{base_url}}" ], "path": [ "api", "user", "map_location_tracking" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "User API — Order / Special" } ], "description": "User API — Order" }, { "name": "Products", "item": [ { "name": "POST — Product Details", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-details", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-details" ] }, "description": "**Endpoint:** `POST /api/user/product-details`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Product\\ProductDetailsRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `mac_address` | `nullable\\|required_if:owner_type,mac_address\\|string\\|min:10\\|max:50` |\n| `product_id` | `required\\|integer\\|exists:products,id` |\n| `measurement_id` | `nullable\\|integer\\|exists:measurements,id` |\n| `owner_type` | `required` |\n| `owner` | `required` |", "body": { "mode": "raw", "raw": "{\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\",\n \"product_id\": 1,\n \"measurement_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-details", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-details", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The mac_address field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-details", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-details" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The mac_address field is required.\",\n \"errors\": {\n \"mac_address\": [\n \"The mac_address field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "GET — Category Products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/category-products/:category_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "category-products", ":category_id" ], "variable": [ { "key": "category_id", "value": "1", "description": "Path parameter: category_id" } ] }, "description": "**Endpoint:** `GET /api/user/category-products/{category_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/category-products/:category_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "category-products", ":category_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/category-products/:category_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "category-products", ":category_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Provider Products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-products/:provider_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-products", ":provider_id" ], "variable": [ { "key": "provider_id", "value": "1", "description": "Path parameter: provider_id" } ] }, "description": "**Endpoint:** `GET /api/user/provider-products/{provider_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-products/:provider_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-products", ":provider_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-products/:provider_id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-products", ":provider_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Filter Products", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/filter-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "filter-products" ] }, "description": "**Endpoint:** `POST /api/user/filter-products`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Product\\FilterProductRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `keyword` | `string\\|nullable` |\n| `provider_id` | `nullable\\|integer\\|exists:providers,id` |\n| `city_id` | `nullable\\|integer\\|exists:cities,id` |\n| `min_weight` | `nullable\\|numeric\\|min:0` |\n| `max_weight` | `nullable\\|numeric\\|min:0` |\n| `feature_ids` | `nullable\\|array` |\n| `feature_ids.*.feature_id` | `nullable\\|integer\\|exists:features,id` |\n| `feature_ids.*.feature_option_id` | `required_if:feature_ids.*.feature_id,!=,null\\|integer\\|exists:feature_options,id` |\n| `min_price` | `nullable\\|numeric\\|min:0` |\n| `max_price` | `nullable\\|numeric\\|min:0` |\n| `latest_added` | `nullable\\|in:true,1` |\n| `products_have_discount` | `nullable\\|in:true,1` |\n| `order_by` | `nullable\\|in:max_rate,max_pay` |", "body": { "mode": "raw", "raw": "{\n \"keyword\": \"example\",\n \"provider_id\": 1,\n \"city_id\": 1,\n \"min_weight\": 1,\n \"max_weight\": 1,\n \"feature_ids\": [\n {\n \"feature_id\": 1,\n \"feature_option_id\": 1\n }\n ],\n \"min_price\": 1,\n \"max_price\": 1,\n \"latest_added\": \"true\",\n \"products_have_discount\": \"true\",\n \"order_by\": \"max_rate\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/filter-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "filter-products" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/filter-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "filter-products" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The keyword field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/filter-products", "host": [ "{{base_url}}" ], "path": [ "api", "user", "filter-products" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The keyword field is required.\",\n \"errors\": {\n \"keyword\": [\n \"The keyword field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Sub Categories By Multi Categories", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sub-categories-by-multi-categories", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sub-categories-by-multi-categories" ] }, "description": "**Endpoint:** `POST /api/user/sub-categories-by-multi-categories`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Category\\SubCategoriesByMultiCategoriesRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `categories_ids` | `required\\|exists:categories,id` |", "body": { "mode": "raw", "raw": "{\n \"categories_ids\": \"example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sub-categories-by-multi-categories", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sub-categories-by-multi-categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sub-categories-by-multi-categories", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sub-categories-by-multi-categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The categories_ids field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/sub-categories-by-multi-categories", "host": [ "{{base_url}}" ], "path": [ "api", "user", "sub-categories-by-multi-categories" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The categories_ids field is required.\",\n \"errors\": {\n \"categories_ids\": [\n \"The categories_ids field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "GET — Rates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-rates/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/product-rates/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-rates/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-rates", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-rates/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-rates", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Rates With Limit", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-rates-with-limit/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-rates-with-limit", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/product-rates-with-limit/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-rates-with-limit/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-rates-with-limit", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/product-rates-with-limit/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "product-rates-with-limit", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "User API — Products" }, { "name": "Profile", "item": [ { "name": "GET — Get Profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "profile" ] }, "description": "**Endpoint:** `GET /api/user/profile`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Ahmed Ali\",\n \"email\": \"user@example.com\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"full_phone\": \"966512345678\",\n \"city_id\": 1,\n \"city_name\": \"Riyadh\",\n \"commercial_number\": \"1234567890\",\n \"lat\": \"24.7136\",\n \"lng\": \"46.6753\",\n \"map_desc\": \"Riyadh\",\n \"is_notify\": true,\n \"balance\": 0,\n \"image\": \"https:\\/\\/example.com\\/storage\\/users\\/default.png\",\n \"token\": \"1|laravel_sanctum_token_example\"\n }\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "profile" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "profile" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PUT — Update Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-profile" ] }, "description": "**Endpoint:** `PUT /api/user/update-profile`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Profile\\UpdateProfileRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `name` | `required\\|string\\|min:2\\|max:50` |\n| `city_id` | `nullable\\|integer\\|exists:cities,id` |\n| `commercial_number` | `required\\|numeric\\|digits_between:10,20\\|Unique` |", "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Ali\",\n \"city_id\": 1,\n \"commercial_number\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-profile" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-profile" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-profile", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-profile" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PATCH — Update Password", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-password" ] }, "description": "**Endpoint:** `PATCH /api/user/update-password`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Profile\\UpdatePasswordRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `old_password` | `required\\|string\\|min:6\\|max:100` |\n| `password` | `required\\|string\\|min:6\\|max:100\\|confirmed` |", "body": { "mode": "raw", "raw": "{\n \"old_password\": \"Password@123\",\n \"password\": \"Password@123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The old_password field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-password" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The old_password field is required.\",\n \"errors\": {\n \"old_password\": [\n \"The old_password field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-password" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "update-password" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Send Code To Old Phone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-send-code" ] }, "description": "**Endpoint:** `POST /api/user/change-phone-old-phone-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Old Phone Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-check-code" ] }, "description": "**Endpoint:** `POST /api/user/change-phone-old-phone-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Profile\\ChangePhoneOldPhoneCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-check-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-old-phone-check-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Send Code To New Phone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-send-code" ] }, "description": "**Endpoint:** `POST /api/user/change-phone-new-phone-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Profile\\ChangePhoneSendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|unique:users,phone,,id,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The country_code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-send-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The country_code field is required.\",\n \"errors\": {\n \"country_code\": [\n \"The country_code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone New Phone Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-check-code" ] }, "description": "**Endpoint:** `POST /api/user/change-phone-new-phone-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Profile\\ChangePhoneCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|digits:4` |\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|unique:users,phone,,id,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-check-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-new-phone-check-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Re Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-re-send-code" ] }, "description": "**Endpoint:** `POST /api/user/change-phone-re-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Profile\\ChangePhoneReSendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `nullable\\|numeric\\|digits_between:1,5` |\n| `phone` | `nullable\\|numeric\\|digits_between:9,10` |\n| `type` | `required\\|in:1,2` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"type\": \"1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-re-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-re-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The type field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-re-send-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The type field is required.\",\n \"errors\": {\n \"type\": [\n \"The type field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-re-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-phone-re-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "User API — Profile" }, { "name": "Provider Registration", "item": [ { "name": "POST — Store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-registration-request", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-registration-request" ] }, "description": "**Endpoint:** `POST /api/user/provider-registration-request`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\StoreRegistrationRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `merchant_name` | `required\\|string\\|min:3\\|max:100` |\n| `store_name` | `required\\|string\\|min:3\\|max:100` |\n| `email` | `required\\|string\\|email:dns,rfc,spoof\\|max:100` |\n| `country_code` | `required\\|string\\|digits_between:1,5` |\n| `phone` | `required\\|string\\|digits_between:9,10` |\n| `store_link` | `nullable\\|url\\|max:500` |", "body": { "mode": "raw", "raw": "{\n \"merchant_name\": \"example\",\n \"store_name\": \"Gold Store\",\n \"email\": \"user@example.com\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"store_link\": \"https:\\/\\/example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-registration-request", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-registration-request" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-registration-request", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-registration-request" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The merchant_name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-registration-request", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-registration-request" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The merchant_name field is required.\",\n \"errors\": {\n \"merchant_name\": [\n \"The merchant_name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] } ], "description": "User API — Provider Registration" }, { "name": "Providers", "item": [ { "name": "GET — All Providers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/all-providers", "host": [ "{{base_url}}" ], "path": [ "api", "user", "all-providers" ] }, "description": "**Endpoint:** `GET /api/user/all-providers`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/all-providers", "host": [ "{{base_url}}" ], "path": [ "api", "user", "all-providers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] }, { "name": "GET — Provider Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-details", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/provider-details/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-details", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-details", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Provider Branches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-branches/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-branches", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/provider-branches/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-branches/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-branches", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-branches/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-branches", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Rates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-rates/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/provider-rates/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-rates/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-rates", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-rates/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-rates", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Rates With Limit", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-rates-with-limit/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-rates-with-limit", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/user/provider-rates-with-limit/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-rates-with-limit/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-rates-with-limit", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/provider-rates-with-limit/:id", "host": [ "{{base_url}}" ], "path": [ "api", "user", "provider-rates-with-limit", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Filter Providers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/filter-providers?keyword=example&name=Ahmed+Ali&city_id=1&category_id=1&provider_activity_id=1&min_rate=1&min_price=1&max_price=1&lat=24.7136&lng=46.6753&is_favorite=true&mac_address=AA%3ABB%3ACC%3ADD%3AEE%3AFF&latest_added=true&products_have_discount=true&products_has_discount=true&order_by=max_rate&sort_by=max_rate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "filter-providers" ], "query": [ { "key": "keyword", "value": "example", "description": "Optional" }, { "key": "name", "value": "Ahmed Ali", "description": "Optional" }, { "key": "city_id", "value": "1", "description": "Optional" }, { "key": "category_id", "value": "1", "description": "Optional" }, { "key": "provider_activity_id", "value": "1", "description": "Optional" }, { "key": "min_rate", "value": "1", "description": "Optional" }, { "key": "min_price", "value": "1", "description": "Optional" }, { "key": "max_price", "value": "1", "description": "Optional" }, { "key": "lat", "value": "24.7136", "description": "Optional" }, { "key": "lng", "value": "46.6753", "description": "Optional" }, { "key": "is_favorite", "value": "true", "description": "Optional" }, { "key": "mac_address", "value": "AA:BB:CC:DD:EE:FF", "description": "Optional" }, { "key": "latest_added", "value": "true", "description": "Optional" }, { "key": "products_have_discount", "value": "true", "description": "Optional" }, { "key": "products_has_discount", "value": "true", "description": "Optional" }, { "key": "order_by", "value": "max_rate", "description": "Optional" }, { "key": "sort_by", "value": "max_rate", "description": "Optional" } ] }, "description": "**Endpoint:** `GET /api/user/filter-providers`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\FilterProviderRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `keyword` | `nullable\\|string\\|max:100` |\n| `name` | `nullable\\|string\\|max:100` |\n| `city_id` | `nullable\\|integer\\|exists:cities,id` |\n| `category_id` | `nullable\\|integer\\|exists:categories,id` |\n| `provider_activity_id` | `nullable\\|integer\\|exists:provider_activities,id` |\n| `min_rate` | `nullable\\|numeric\\|min:0\\|max:5` |\n| `min_price` | `nullable\\|numeric\\|min:0` |\n| `max_price` | `nullable\\|numeric\\|min:0\\|gte:min_price` |\n| `lat` | `nullable\\|numeric` |\n| `lng` | `nullable\\|numeric` |\n| `is_favorite` | `nullable\\|in:true,1,false,0` |\n| `mac_address` | `nullable\\|string\\|max:191` |\n| `latest_added` | `nullable\\|in:true,1` |\n| `products_have_discount` | `nullable\\|in:true,1` |\n| `products_has_discount` | `nullable\\|in:true,1` |\n| `order_by` | `nullable\\|in:max_rate,nearest,latest` |\n| `sort_by` | `nullable\\|in:max_rate,nearest,latest` |" }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/filter-providers?keyword=example&name=Ahmed+Ali&city_id=1&category_id=1&provider_activity_id=1&min_rate=1&min_price=1&max_price=1&lat=24.7136&lng=46.6753&is_favorite=true&mac_address=AA%3ABB%3ACC%3ADD%3AEE%3AFF&latest_added=true&products_have_discount=true&products_has_discount=true&order_by=max_rate&sort_by=max_rate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "filter-providers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/filter-providers?keyword=example&name=Ahmed+Ali&city_id=1&category_id=1&provider_activity_id=1&min_rate=1&min_price=1&max_price=1&lat=24.7136&lng=46.6753&is_favorite=true&mac_address=AA%3ABB%3ACC%3ADD%3AEE%3AFF&latest_added=true&products_have_discount=true&products_has_discount=true&order_by=max_rate&sort_by=max_rate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "filter-providers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The keyword field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/filter-providers?keyword=example&name=Ahmed+Ali&city_id=1&category_id=1&provider_activity_id=1&min_rate=1&min_price=1&max_price=1&lat=24.7136&lng=46.6753&is_favorite=true&mac_address=AA%3ABB%3ACC%3ADD%3AEE%3AFF&latest_added=true&products_have_discount=true&products_has_discount=true&order_by=max_rate&sort_by=max_rate", "host": [ "{{base_url}}" ], "path": [ "api", "user", "filter-providers" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The keyword field is required.\",\n \"errors\": {\n \"keyword\": [\n \"The keyword field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] } ], "description": "User API — Providers" }, { "name": "User", "item": [ { "name": "PATCH — Change Lang", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-lang" ] }, "description": "**Endpoint:** `PATCH /api/user/change-lang`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-lang" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-lang" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "user", "change-lang" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "User API — User" }, { "name": "Wallet", "item": [ { "name": "GET — Show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/show-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "user", "show-wallet" ] }, "description": "**Endpoint:** `GET /api/user/show-wallet`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/show-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "user", "show-wallet" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"balance\": 150.5\n }\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/show-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "user", "show-wallet" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/show-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "user", "show-wallet" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Charge", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/charge-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "user", "charge-wallet" ] }, "description": "**Endpoint:** `POST /api/user/charge-wallet`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/charge-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "user", "charge-wallet" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/charge-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "user", "charge-wallet" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/charge-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "user", "charge-wallet" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Wallet Transactions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/get-wallet-transactions/:type", "host": [ "{{base_url}}" ], "path": [ "api", "user", "get-wallet-transactions", ":type" ], "variable": [ { "key": "type", "value": "1", "description": "Path parameter: type" } ] }, "description": "**Endpoint:** `GET /api/user/get-wallet-transactions/{type}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/get-wallet-transactions/:type", "host": [ "{{base_url}}" ], "path": [ "api", "user", "get-wallet-transactions", ":type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/get-wallet-transactions/:type", "host": [ "{{base_url}}" ], "path": [ "api", "user", "get-wallet-transactions", ":type" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/get-wallet-transactions/:type", "host": [ "{{base_url}}" ], "path": [ "api", "user", "get-wallet-transactions", ":type" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{user_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/user/get-wallet-transactions/:type", "host": [ "{{base_url}}" ], "path": [ "api", "user", "get-wallet-transactions", ":type" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "User API — Wallet" } ], "description": "User (customer) app API. Prefix: `{{base_url}}/api/user`" }, { "name": "Provider API", "item": [ { "name": "Authentication", "item": [ { "name": "GET — Activities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/activities", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "activities" ] }, "description": "**Endpoint:** `GET /api/provider/activities`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/activities", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "activities" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] }, { "name": "GET — Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/categories", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "categories" ] }, "description": "**Endpoint:** `GET /api/provider/categories`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/categories", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" } ] }, { "name": "POST — Forget Password Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/forget-password-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "forget-password-send-code" ] }, "description": "**Endpoint:** `POST /api/provider/forget-password-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\ForgetPassword\\ForgetPasswordSendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `nullable\\|RequiredIf\\|numeric\\|digits_between:1,5` |\n| `phone_or_email` | `required\\|string` |\n| `phone` | `nullable\\|RequiredIf\\|numeric\\|digits_between:9,10\\|Exists` |\n| `email` | `nullable\\|RequiredIf\\|email:dns\\|Exists` |\n| `is_email` | `nullable\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone_or_email\": \"example\",\n \"phone\": \"512345678\",\n \"email\": \"user@example.com\",\n \"is_email\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/forget-password-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "forget-password-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/forget-password-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "forget-password-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The phone_or_email field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/forget-password-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "forget-password-send-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The phone_or_email field is required.\",\n \"errors\": {\n \"phone_or_email\": [\n \"The phone_or_email field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Forget Password Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/forget-password-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "forget-password-check-code" ] }, "description": "**Endpoint:** `POST /api/provider/forget-password-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\ForgetPassword\\ForgetPasswordCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|digits:4` |\n| `country_code` | `nullable\\|RequiredIf\\|numeric\\|digits_between:1,5` |\n| `phone_or_email` | `required\\|string` |\n| `phone` | `nullable\\|RequiredIf\\|numeric\\|digits_between:9,10\\|Exists` |\n| `email` | `nullable\\|RequiredIf\\|email:dns\\|Exists` |\n| `is_email` | `nullable\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone_or_email\": \"example\",\n \"phone\": \"512345678\",\n \"email\": \"user@example.com\",\n \"is_email\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/forget-password-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "forget-password-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/forget-password-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "forget-password-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/forget-password-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "forget-password-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reset-password" ] }, "description": "**Endpoint:** `POST /api/provider/reset-password`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\ForgetPassword\\ResetPasswordRequest`\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|digits:4` |\n| `country_code` | `nullable\\|RequiredIf\\|numeric\\|digits_between:1,5` |\n| `phone_or_email` | `required\\|string` |\n| `phone` | `nullable\\|RequiredIf\\|numeric\\|digits_between:9,10\\|Exists` |\n| `email` | `nullable\\|RequiredIf\\|email:dns\\|Exists` |\n| `password` | `required\\|string\\|min:6\\|max:100\\|confirmed` |\n| `is_email` | `nullable\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone_or_email\": \"example\",\n \"phone\": \"512345678\",\n \"email\": \"user@example.com\",\n \"password\": \"Password@123\",\n \"is_email\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reset-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reset-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reset-password" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-in" ] }, "description": "**Endpoint:** `POST /api/provider/sign-in`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Auth\\LoginRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `sometimes\\|required\\|numeric\\|digits_between:1,5` |\n| `phone` | `sometimes\\|required_without:email\\|numeric\\|digits_between:9,10\\|exists:providers,phone,country_code,` |\n| `email` | `sometimes\\|required_without:phone\\|email\\|exists:providers,store_email` |\n| `password` | `required\\|string\\|max:100` |\n| `device_id` | `required\\|max:250` |\n| `device_type` | `in:ios,android,web` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"email\": \"user@example.com\",\n \"password\": \"Password@123\",\n \"device_id\": \"device-uuid-12345\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-in" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Provider Name\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"is_notify\": true,\n \"commercial_number\": \"1234567890\",\n \"city\": {\n \"id\": 1,\n \"name\": \"Riyadh\"\n },\n \"district\": {\n \"id\": 1,\n \"name\": \"Al Olaya\"\n },\n \"street\": \"King Fahd Road\",\n \"store_image\": \"https:\\/\\/example.com\\/storage\\/stores\\/1.png\",\n \"store_email\": \"store@example.com\",\n \"store_name\": \"Gold Store\",\n \"provider_activity_id\": {\n \"id\": 1,\n \"name\": \"Jewelry\"\n },\n \"description\": \"Store description\",\n \"identity_number\": \"1234567890\",\n \"shipping_service_available\": {\n \"text\": \"\",\n \"value\": true\n },\n \"installment_payments_available\": {\n \"text\": \"\",\n \"value\": false\n },\n \"accept_commission_terms\": true,\n \"token\": \"1|laravel_sanctum_token_example\"\n }\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-in" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The country_code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-in" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The country_code field is required.\",\n \"errors\": {\n \"country_code\": [\n \"The country_code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Need Active (203)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-in" ] } }, "status": "Non-Authoritative Information", "code": 203, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"needActive\",\n \"msg\": \"Account not activated\",\n \"data\": {\n \"phone\": \"512345678\",\n \"country_code\": \"966\"\n }\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "try {", " const res = pm.response.json();", " const token = res?.data?.token;", " if (token) {", " pm.collectionVariables.set('provider_token', token);", " pm.environment.set('provider_token', token);", " console.log('Saved provider_token');", " }", "} catch (e) { console.warn(e); }" ] } } ] }, { "name": "POST — Register", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/provider/sign-up", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-up" ] }, "description": "**Endpoint:** `POST /api/provider/sign-up`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Auth\\RegisterRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `store_image` | `required\\|image\\|mimes:jpeg,jpg,png,webp\\|max:2048` |\n| `store_name` | `required\\|string\\|min:2\\|max:100\\|unique:providers,store_name,NULL,id,deleted_at,NULL` |\n| `name` | `required\\|string\\|min:2\\|max:100` |\n| `store_email` | `required\\|email\\|unique:providers,store_email,NULL,id,deleted_at,NULL` |\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|unique:providers,phone,NULL,id,deleted_at,NULL` |\n| `provider_activity_id` | `required\\|integer\\|exists:provider_activities,id` |\n| `city_id` | `required\\|integer\\|exists:cities,id` |\n| `district_id` | `required\\|integer\\|exists:districts,id` |\n| `street` | `required\\|string\\|min:2\\|max:191` |\n| `password` | `required\\|string\\|min:6\\|max:100\\|confirmed` |\n| `commercial_number` | `required\\|numeric\\|digits_between:10,20\\|unique:providers,commercial_number,NULL,id,deleted_at,NULL` |\n| `identity_number` | `required\\|numeric\\|digits_between:10,20\\|unique:providers,identity_number,NULL,id,deleted_at,NULL` |\n| `commercial_register_file` | `required\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `occupation_license_file` | `required\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `shop_license_file` | `required\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `stamp_certificate_file` | `required\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `identity_file` | `required\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `description` | `required\\|string\\|min:3\\|max:500` |", "body": { "mode": "formdata", "formdata": [ { "key": "store_image", "type": "file", "src": [], "description": "Required file" }, { "key": "store_name", "value": "Gold Store", "type": "text", "description": "Required" }, { "key": "name", "value": "Ahmed Ali", "type": "text", "description": "Required" }, { "key": "store_email", "value": "store@example.com", "type": "text", "description": "Required" }, { "key": "country_code", "value": "966", "type": "text", "description": "Required" }, { "key": "phone", "value": "512345678", "type": "text", "description": "Required" }, { "key": "provider_activity_id", "value": "1", "type": "text", "description": "Required" }, { "key": "city_id", "value": "1", "type": "text", "description": "Required" }, { "key": "district_id", "value": "1", "type": "text", "description": "Required" }, { "key": "street", "value": "King Fahd Road", "type": "text", "description": "Required" }, { "key": "password", "value": "Password@123", "type": "text", "description": "Required" }, { "key": "commercial_number", "value": "1234567890", "type": "text", "description": "Required" }, { "key": "identity_number", "value": "1234567890", "type": "text", "description": "Required" }, { "key": "commercial_register_file", "type": "file", "src": [], "description": "Required file" }, { "key": "occupation_license_file", "type": "file", "src": [], "description": "Required file" }, { "key": "shop_license_file", "type": "file", "src": [], "description": "Required file" }, { "key": "stamp_certificate_file", "type": "file", "src": [], "description": "Required file" }, { "key": "identity_file", "type": "file", "src": [], "description": "Required file" }, { "key": "description", "value": "Product description example", "type": "text", "description": "Required" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/provider/sign-up", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-up" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/provider/sign-up", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-up" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The store_image field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/provider/sign-up", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-up" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The store_image field is required.\",\n \"errors\": {\n \"store_image\": [\n \"The store_image field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Resend Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "resend-code" ] }, "description": "**Endpoint:** `POST /api/provider/resend-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Auth\\ResendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `nullable\\|RequiredIf\\|numeric\\|digits_between:1,5` |\n| `phone_or_email` | `required\\|string` |\n| `phone` | `nullable\\|RequiredIf\\|numeric\\|digits_between:9,10\\|Exists` |\n| `email` | `nullable\\|RequiredIf\\|email:dns\\|Exists` |\n| `is_email` | `nullable\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone_or_email\": \"example\",\n \"phone\": \"512345678\",\n \"email\": \"user@example.com\",\n \"is_email\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "resend-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "resend-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The phone_or_email field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "resend-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The phone_or_email field is required.\",\n \"errors\": {\n \"phone_or_email\": [\n \"The phone_or_email field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "PATCH — Activate", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/activate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "activate" ] }, "description": "**Endpoint:** `PATCH /api/provider/activate`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Auth\\ActivateRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|digits:4` |\n| `country_code` | `nullable\\|RequiredIf\\|numeric\\|digits_between:1,5` |\n| `phone_or_email` | `required\\|string` |\n| `phone` | `nullable\\|RequiredIf\\|numeric\\|digits_between:9,10\\|Exists` |\n| `email` | `nullable\\|RequiredIf\\|email:dns\\|Exists` |\n| `device_id` | `required\\|max:250` |\n| `device_type` | `in:ios,android,web` |\n| `is_email` | `nullable\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone_or_email\": \"example\",\n \"phone\": \"512345678\",\n \"email\": \"user@example.com\",\n \"device_id\": \"device-uuid-12345\",\n \"device_type\": \"ios\",\n \"is_email\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/activate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Provider Name\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"is_notify\": true,\n \"commercial_number\": \"1234567890\",\n \"city\": {\n \"id\": 1,\n \"name\": \"Riyadh\"\n },\n \"district\": {\n \"id\": 1,\n \"name\": \"Al Olaya\"\n },\n \"street\": \"King Fahd Road\",\n \"store_image\": \"https:\\/\\/example.com\\/storage\\/stores\\/1.png\",\n \"store_email\": \"store@example.com\",\n \"store_name\": \"Gold Store\",\n \"provider_activity_id\": {\n \"id\": 1,\n \"name\": \"Jewelry\"\n },\n \"description\": \"Store description\",\n \"identity_number\": \"1234567890\",\n \"shipping_service_available\": {\n \"text\": \"\",\n \"value\": true\n },\n \"installment_payments_available\": {\n \"text\": \"\",\n \"value\": false\n },\n \"accept_commission_terms\": true,\n \"token\": \"1|laravel_sanctum_token_example\"\n }\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/activate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/activate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "activate" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Need Active (203)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/provider/activate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "activate" ] } }, "status": "Non-Authoritative Information", "code": 203, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"needActive\",\n \"msg\": \"Account not activated\",\n \"data\": {\n \"phone\": \"512345678\",\n \"country_code\": \"966\"\n }\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "try {", " const res = pm.response.json();", " const token = res?.data?.token;", " if (token) {", " pm.collectionVariables.set('provider_token', token);", " pm.environment.set('provider_token', token);", " console.log('Saved provider_token');", " }", "} catch (e) { console.warn(e); }" ] } } ] }, { "name": "DELETE — Logout", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-out" ] }, "description": "**Endpoint:** `DELETE /api/provider/sign-out`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-out" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-out" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "sign-out" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Authentication" }, { "name": "Branches", "item": [ { "name": "GET — Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "index" ] }, "description": "**Endpoint:** `GET /api/provider/branches/index`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "index" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "index" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "index" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "show" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/branches/{id}/show`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "show" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "show" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "show" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "show" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "store" ] }, "description": "**Endpoint:** `POST /api/provider/branches/store`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Branch\\StoreBranchRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `city_id` | `required\\|exists:cities,id` |\n| `address_details` | `required\\|min:5\\|max:2000` |\n| `employees` | `required\\|array` |\n| `employees.*.name` | `required\\|min:2\\|max:191` |\n| `employees.*.is_active` | `required\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"city_id\": 1,\n \"address_details\": \"example\",\n \"employees\": [\n {\n \"name\": \"Ahmed Ali\",\n \"is_active\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The city_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "store" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The city_id field is required.\",\n \"errors\": {\n \"city_id\": [\n \"The city_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "store" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", "store" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PUT — Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "update" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `PUT /api/provider/branches/{id}/update`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Branch\\UpdateBranchRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `city_id` | `required\\|exists:cities,id` |\n| `address_details` | `required\\|min:5\\|max:2000` |\n| `employees` | `required\\|array` |\n| `employees.*.id` | `sometimes\\|exists:branch_employees,id,branch_id,` |\n| `employees.*.name` | `required\\|min:2\\|max:191` |\n| `employees.*.is_active` | `required\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"city_id\": 1,\n \"address_details\": \"example\",\n \"employees\": [\n {\n \"id\": \"example\",\n \"name\": \"Ahmed Ali\",\n \"is_active\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "update" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "update" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The city_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "update" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The city_id field is required.\",\n \"errors\": {\n \"city_id\": [\n \"The city_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "update" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "update" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "update" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "DELETE — Destroy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "destroy" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `DELETE /api/provider/branches/{id}/destroy`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "destroy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "destroy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "destroy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:id/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":id", "destroy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Add Employee", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/add-employee", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "add-employee" ], "variable": [ { "key": "branchId", "value": "1", "description": "Path parameter: branchId" } ] }, "description": "**Endpoint:** `POST /api/provider/branches/{branchId}/add-employee`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Branch\\AddEmployeeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `employees` | `required\\|array` |\n| `employees.*.name` | `required\\|min:2\\|max:191` |\n| `employees.*.is_active` | `required\\|boolean` |", "body": { "mode": "raw", "raw": "{\n \"employees\": [\n {\n \"name\": \"Ahmed Ali\",\n \"is_active\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/add-employee", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "add-employee" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/add-employee", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "add-employee" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The employees field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/add-employee", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "add-employee" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The employees field is required.\",\n \"errors\": {\n \"employees\": [\n \"The employees field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/add-employee", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "add-employee" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/add-employee", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "add-employee" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/add-employee", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "add-employee" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "DELETE — Destroy Employee", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/employees/:employeeId/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "employees", ":employeeId", "destroy" ], "variable": [ { "key": "branchId", "value": "1", "description": "Path parameter: branchId" }, { "key": "employeeId", "value": "1", "description": "Path parameter: employeeId" } ] }, "description": "**Endpoint:** `DELETE /api/provider/branches/{branchId}/employees/{employeeId}/destroy`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/employees/:employeeId/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "employees", ":employeeId", "destroy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/employees/:employeeId/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "employees", ":employeeId", "destroy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/employees/:employeeId/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "employees", ":employeeId", "destroy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/branches/:branchId/employees/:employeeId/destroy", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "branches", ":branchId", "employees", ":employeeId", "destroy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Provider API — Branches" }, { "name": "Complaints", "item": [ { "name": "GET — Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints" ] }, "description": "**Endpoint:** `GET /api/provider/complaints`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Pluck Order Ids", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/pluck-order-ids", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "pluck-order-ids" ] }, "description": "**Endpoint:** `GET /api/provider/complaints/pluck-order-ids`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/pluck-order-ids", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "pluck-order-ids" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/pluck-order-ids", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "pluck-order-ids" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/pluck-order-ids", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "pluck-order-ids" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Store Complaint", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "store" ] }, "description": "**Endpoint:** `POST /api/provider/complaints/store`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Complaint\\StoreComplaintRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `type` | `required\\|in:inquiry,order_issue,technical_issue,money_issue,suggestion` |\n| `order_id` | `required\\|exists:orders,id,provider_id,` |\n| `subject` | `sometimes\\|max:50` |\n| `email` | `sometimes\\|email\\|max:50` |\n| `complaint` | `required\\|max:500` |\n| `images` | `nullable\\|array` |\n| `images.*` | `nullable\\|file` |", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "inquiry", "type": "text", "description": "Required" }, { "key": "order_id", "value": "1", "type": "text", "description": "Required" }, { "key": "subject", "value": "example", "type": "text", "description": "Optional" }, { "key": "email", "value": "user@example.com", "type": "text", "description": "Optional" }, { "key": "complaint", "value": "Issue with delivery", "type": "text", "description": "Required" }, { "key": "images[0]", "type": "file", "src": [], "description": "Optional file" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The type field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "store" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The type field is required.\",\n \"errors\": {\n \"type\": [\n \"The type field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "store" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "store" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "show", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/complaints/show/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "show", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "show", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "show", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/complaints/show/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "complaints", "show", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Provider API — Complaints" }, { "name": "Contact Messages", "item": [ { "name": "POST — Store Contact Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "send-contact-message" ] }, "description": "**Endpoint:** `POST /api/provider/send-contact-message`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\ContactMessage\\ContactMessageRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `name` | `required\\|min:3\\|max:50` |\n| `country_code` | `required\\|numeric\\|digits:3` |\n| `phone` | `required\\|numeric\\|digits_between:9,10` |\n| `subject` | `required\\|min:10\\|max:5000` |\n| `title` | `nullable` |\n| `image` | `nullable\\|image\\|mimes:jpeg,jpg,png,webp\\|max:2048` |\n| `contactable_id` | `nullable` |\n| `contactable_type` | `nullable` |", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Ahmed Ali", "type": "text", "description": "Required" }, { "key": "country_code", "value": "966", "type": "text", "description": "Required" }, { "key": "phone", "value": "512345678", "type": "text", "description": "Required" }, { "key": "subject", "value": "example", "type": "text", "description": "Required" }, { "key": "title", "value": "Golden Ring", "type": "text", "description": "Optional" }, { "key": "image", "type": "file", "src": [], "description": "Optional file" }, { "key": "contactable_id", "value": "1", "type": "text", "description": "Optional" }, { "key": "contactable_type", "value": "example", "type": "text", "description": "Optional" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "send-contact-message" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "send-contact-message" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "send-contact-message" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "send-contact-message" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/send-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "send-contact-message" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Contact Messages" }, { "name": "Financial Reports", "item": [ { "name": "POST — Index", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/financial-reports", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "financial-reports" ] }, "description": "**Endpoint:** `POST /api/provider/financial-reports`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\FinancialReports\\FilterFinancialReportsRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `search` | `nullable\\|string\\|max:191` |", "body": { "mode": "raw", "raw": "{\n \"search\": \"gold\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/financial-reports", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "financial-reports" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/financial-reports", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "financial-reports" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The search field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/financial-reports", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "financial-reports" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The search field is required.\",\n \"errors\": {\n \"search\": [\n \"The search field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/financial-reports", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "financial-reports" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/financial-reports", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "financial-reports" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Financial Reports" }, { "name": "Home", "item": [ { "name": "GET — Home", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/home", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "home" ] }, "description": "**Endpoint:** `GET /api/provider/home`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/home", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "home" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/home", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "home" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/home", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "home" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Home" }, { "name": "Notifications", "item": [ { "name": "PATCH — Switch Notification Status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-notify" ] }, "description": "**Endpoint:** `PATCH /api/provider/switch-notify`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-notify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-notify" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-notify" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Notifications With Limit", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "notifications-with-limit" ] }, "description": "**Endpoint:** `GET /api/provider/notifications-with-limit`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "notifications-with-limit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "notifications-with-limit" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "notifications-with-limit" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "notifications" ] }, "description": "**Endpoint:** `GET /api/provider/notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Count Unread Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "count-notifications" ] }, "description": "**Endpoint:** `GET /api/provider/count-notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "count-notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"count\": 3\n }\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "count-notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "count-notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "DELETE — Delete Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notification", ":notification_id" ], "variable": [ { "key": "notification_id", "value": "1", "description": "Path parameter: notification_id" } ] }, "description": "**Endpoint:** `DELETE /api/provider/delete-notification/{notification_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notification", ":notification_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notification", ":notification_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notification", ":notification_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notification", ":notification_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "DELETE — Delete Notifications", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notifications" ] }, "description": "**Endpoint:** `DELETE /api/provider/delete-notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "delete-notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Notifications" }, { "name": "Order", "item": [ { "name": "Normal", "item": [ { "name": "GET — All Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/all", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "all" ] }, "description": "**Endpoint:** `GET /api/provider/orders/all`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/all", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "all" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/all", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "all" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/all", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "all" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — New Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/new", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "new" ] }, "description": "**Endpoint:** `GET /api/provider/orders/new`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/new", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "new" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/new", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "new" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/new", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "new" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Processed Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/processed", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "processed" ] }, "description": "**Endpoint:** `GET /api/provider/orders/processed`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/processed", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "processed" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/processed", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "processed" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/processed", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "processed" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Deliver To Delegate Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-to-delegate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-to-delegate" ] }, "description": "**Endpoint:** `GET /api/provider/orders/deliver-to-delegate`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-to-delegate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-to-delegate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-to-delegate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-to-delegate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-to-delegate", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-to-delegate" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Ready For Deliver Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver" ] }, "description": "**Endpoint:** `GET /api/provider/orders/ready-for-deliver`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Ready For Shipping Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping" ] }, "description": "**Endpoint:** `GET /api/provider/orders/ready-for-shipping`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — In Transit Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-transit", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-transit" ] }, "description": "**Endpoint:** `GET /api/provider/orders/in-transit`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-transit", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-transit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-transit", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-transit" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-transit", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-transit" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Delivered Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/delivered", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "delivered" ] }, "description": "**Endpoint:** `GET /api/provider/orders/delivered`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/delivered", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "delivered" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/delivered", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "delivered" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/delivered", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "delivered" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Finished Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finished", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finished" ] }, "description": "**Endpoint:** `GET /api/provider/orders/finished`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finished", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finished" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finished", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finished" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finished", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finished" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "details", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/orders/details/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "details", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "details", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "details", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "details", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Invoice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/invoice/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "invoice", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/orders/invoice/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/invoice/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "invoice", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/invoice/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "invoice", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/invoice/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "invoice", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/invoice/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "invoice", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — In Progress Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-progress/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-progress", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/provider/orders/in-progress/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Order\\InProgressOrderRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-progress/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-progress", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-progress/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-progress", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-progress/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-progress", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/in-progress/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "in-progress", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Ready For Shipping Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/provider/orders/ready-for-shipping/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-shipping/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-shipping", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Ready For Deliver Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/provider/orders/ready-for-deliver/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/ready-for-deliver/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "ready-for-deliver", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Refuse Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/refuse/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "refuse", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/provider/orders/refuse/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Order\\RejectOrderRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `refused_reason` | `required\\|string\\|min:2\\|max:500` |", "body": { "mode": "raw", "raw": "{\n \"refused_reason\": \"example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/refuse/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "refuse", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/refuse/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "refuse", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The refused_reason field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/refuse/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "refuse", ":id" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The refused_reason field is required.\",\n \"errors\": {\n \"refused_reason\": [\n \"The refused_reason field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/refuse/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "refuse", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/refuse/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "refuse", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/refuse/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "refuse", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Deliver Order To Delegate", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-order-to-delegate/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-order-to-delegate", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/orders/deliver-order-to-delegate/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-order-to-delegate/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-order-to-delegate", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-order-to-delegate/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-order-to-delegate", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-order-to-delegate/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-order-to-delegate", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/deliver-order-to-delegate/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "deliver-order-to-delegate", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — On Way Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/on-way/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "on-way", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/orders/on-way/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/on-way/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "on-way", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/on-way/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "on-way", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/on-way/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "on-way", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/on-way/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "on-way", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Finish Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finish/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finish", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/orders/finish/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finish/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finish", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finish/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finish", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finish/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finish", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/orders/finish/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "orders", "finish", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Provider API — Order / Normal" } ], "description": "Provider API — Order" }, { "name": "Packages", "item": [ { "name": "GET — Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages" ] }, "description": "**Endpoint:** `GET /api/provider/packages`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Subscribe", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/subscribe", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "subscribe" ] }, "description": "**Endpoint:** `POST /api/provider/packages/subscribe`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Package\\SubscribeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `package_id` | `required` |\n| `coupon_code` | `sometimes\\|exists:coupons,coupon_num` |\n| `price` | `required\\|numeric\\|min:0` |\n| `start_date` | `required\\|date\\|after_or_equal:today` |\n| `end_date` | `required\\|date\\|after:start_date` |\n| `payment_type` | `required\\|in:online,wallet,test` |\n| `provider_id` | `required\\|exists:providers,id` |", "body": { "mode": "raw", "raw": "{\n \"package_id\": 1,\n \"coupon_code\": \"SAVE10\",\n \"price\": 100,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"payment_type\": \"online\",\n \"provider_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/subscribe", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "subscribe" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/subscribe", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "subscribe" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The package_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/subscribe", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "subscribe" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The package_id field is required.\",\n \"errors\": {\n \"package_id\": [\n \"The package_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/subscribe", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "subscribe" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/subscribe", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "subscribe" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — My Subscriptions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/my-subscriptions", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "my-subscriptions" ] }, "description": "**Endpoint:** `GET /api/provider/packages/my-subscriptions`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/my-subscriptions", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "my-subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/my-subscriptions", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "my-subscriptions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/packages/my-subscriptions", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "packages", "my-subscriptions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Packages" }, { "name": "Products", "item": [ { "name": "GET — Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "index" ] }, "description": "**Endpoint:** `GET /api/provider/products/index`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "index" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "index" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "index" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Product Sales", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/sales", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "sales" ] }, "description": "**Endpoint:** `GET /api/provider/products/sales`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/sales", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "sales" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/sales", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "sales" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/sales", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "sales" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "store" ] }, "description": "**Endpoint:** `POST /api/provider/products/store`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Product\\Store`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `title` | `required\\|array` |\n| `condition` | `required\\|in:new,used` |\n| `pieces_count` | `nullable\\|integer\\|min:1` |\n| `weight` | `nullable\\|numeric\\|min:0` |\n| `sale_discount_type` | `required\\|in:none,percentage,fixed` |\n| `sale_discount_value` | `nullable\\|numeric\\|min:0\\|required_unless:sale_discount_type,none` |\n| `sale_discount_start_date` | `required_with:sale_discount_value\\|date_format:Y/m/d` |\n| `sale_discount_start_time` | `required_with:sale_discount_value\\|date_format:H:i` |\n| `sale_discount_end_date` | `required_with:sale_discount_value\\|date_format:Y/m/d\\|after:sale_discount_start_date` |\n| `sale_discount_end_time` | `required_with:sale_discount_value\\|date_format:H:i` |\n| `origin_country_id` | `nullable\\|exists:countries,id` |\n| `craftsmanship_fee` | `nullable\\|numeric\\|min:0` |\n| `stock_qty` | `required\\|integer\\|min:0` |\n| `price` | `required\\|numeric\\|min:0` |\n| `category_id` | `required\\|exists:categories,id` |\n| `images` | `required\\|array\\|min:1` |\n| `images.*` | `required\\|image` |", "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Golden Ring", "type": "text", "description": "Required" }, { "key": "condition", "value": "new", "type": "text", "description": "Required" }, { "key": "pieces_count", "value": "1", "type": "text", "description": "Optional" }, { "key": "weight", "value": "10.5", "type": "text", "description": "Optional" }, { "key": "sale_discount_type", "value": "none", "type": "text", "description": "Required" }, { "key": "sale_discount_value", "value": "0", "type": "text", "description": "Required" }, { "key": "sale_discount_start_date", "value": "2024/06/01", "type": "text", "description": "Required" }, { "key": "sale_discount_start_time", "value": "10:00", "type": "text", "description": "Required" }, { "key": "sale_discount_end_date", "value": "2024/06/01", "type": "text", "description": "Required" }, { "key": "sale_discount_end_time", "value": "10:00", "type": "text", "description": "Required" }, { "key": "origin_country_id", "value": "1", "type": "text", "description": "Optional" }, { "key": "craftsmanship_fee", "value": "15.5", "type": "text", "description": "Optional" }, { "key": "stock_qty", "value": "10", "type": "text", "description": "Required" }, { "key": "price", "value": "100", "type": "text", "description": "Required" }, { "key": "category_id", "value": "1", "type": "text", "description": "Required" }, { "key": "images[0]", "type": "file", "src": [], "description": "Required file" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The title field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "store" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The title field is required.\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "store" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "store" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PUT — Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "update" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `PUT /api/provider/products/{id}/update`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Product\\Update`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `title` | `required\\|array` |\n| `title.ar` | `required\\|string\\|min:3\\|max:191` |\n| `title.en` | `nullable\\|string\\|min:3\\|max:191` |\n| `condition` | `required\\|in:new,used` |\n| `pieces_count` | `nullable\\|integer\\|min:1` |\n| `weight` | `nullable\\|numeric\\|min:0` |\n| `sale_discount_type` | `required\\|in:none,percentage,fixed` |\n| `sale_discount_value` | `nullable\\|numeric\\|min:0\\|required_unless:sale_discount_type,none` |\n| `sale_discount_start_date` | `required_with:sale_discount_value\\|date_format:Y/m/d` |\n| `sale_discount_start_time` | `required_with:sale_discount_value\\|date_format:H:i` |\n| `sale_discount_end_date` | `required_with:sale_discount_value\\|date_format:Y/m/d\\|after:sale_discount_start_date` |\n| `sale_discount_end_time` | `required_with:sale_discount_value\\|date_format:H:i` |\n| `origin_country_id` | `nullable\\|exists:countries,id` |\n| `craftsmanship_fee` | `nullable\\|numeric\\|min:0` |\n| `stock_qty` | `required\\|integer\\|min:0` |\n| `price` | `required\\|numeric\\|min:0` |\n| `category_id` | `required\\|exists:categories,id` |\n| `images` | `nullable\\|array` |\n| `images.*` | `nullable\\|image` |", "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Golden Ring", "type": "text", "description": "Required" }, { "key": "condition", "value": "new", "type": "text", "description": "Required" }, { "key": "pieces_count", "value": "1", "type": "text", "description": "Optional" }, { "key": "weight", "value": "10.5", "type": "text", "description": "Optional" }, { "key": "sale_discount_type", "value": "none", "type": "text", "description": "Required" }, { "key": "sale_discount_value", "value": "0", "type": "text", "description": "Required" }, { "key": "sale_discount_start_date", "value": "2024/06/01", "type": "text", "description": "Required" }, { "key": "sale_discount_start_time", "value": "10:00", "type": "text", "description": "Required" }, { "key": "sale_discount_end_date", "value": "2024/06/01", "type": "text", "description": "Required" }, { "key": "sale_discount_end_time", "value": "10:00", "type": "text", "description": "Required" }, { "key": "origin_country_id", "value": "1", "type": "text", "description": "Optional" }, { "key": "craftsmanship_fee", "value": "15.5", "type": "text", "description": "Optional" }, { "key": "stock_qty", "value": "10", "type": "text", "description": "Required" }, { "key": "price", "value": "100", "type": "text", "description": "Required" }, { "key": "category_id", "value": "1", "type": "text", "description": "Required" }, { "key": "title.ar", "value": "example", "type": "text", "description": "Required" }, { "key": "title.en", "value": "example", "type": "text", "description": "Optional" }, { "key": "images[0]", "type": "file", "src": [], "description": "Optional file" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "update" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "update" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The title field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "update" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The title field is required.\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "update" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "update" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/update", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "update" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "show" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/products/{id}/show`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "show" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "show" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "show" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id/show", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id", "show" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "PATCH — Toggle Product Status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/toggle-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "toggle-status" ] }, "description": "**Endpoint:** `PATCH /api/provider/products/toggle-status`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Product\\ToggleStatusRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `product_id` | `required\\|exists:products,id` |", "body": { "mode": "raw", "raw": "{\n \"product_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/toggle-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "toggle-status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/toggle-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "toggle-status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The product_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/toggle-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "toggle-status" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The product_id field is required.\",\n \"errors\": {\n \"product_id\": [\n \"The product_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/toggle-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "toggle-status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/toggle-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", "toggle-status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "DELETE — Delete Image", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:product_id/delete-image/:image_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":product_id", "delete-image", ":image_id" ], "variable": [ { "key": "product_id", "value": "1", "description": "Path parameter: product_id" }, { "key": "image_id", "value": "1", "description": "Path parameter: image_id" } ] }, "description": "**Endpoint:** `DELETE /api/provider/products/{product_id}/delete-image/{image_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:product_id/delete-image/:image_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":product_id", "delete-image", ":image_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:product_id/delete-image/:image_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":product_id", "delete-image", ":image_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:product_id/delete-image/:image_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":product_id", "delete-image", ":image_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:product_id/delete-image/:image_id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":product_id", "delete-image", ":image_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "DELETE — Destroy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `DELETE /api/provider/products/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/products/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "products", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Provider API — Products" }, { "name": "Profile & Settings", "item": [ { "name": "POST — Switch Installments Payment Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-installments-payment-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-installments-payment-status" ] }, "description": "**Endpoint:** `POST /api/provider/switch-installments-payment-status`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-installments-payment-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-installments-payment-status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-installments-payment-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-installments-payment-status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-installments-payment-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-installments-payment-status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Switch Shipping Service Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-shipping-service-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-shipping-service-status" ] }, "description": "**Endpoint:** `POST /api/provider/switch-shipping-service-status`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-shipping-service-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-shipping-service-status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-shipping-service-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-shipping-service-status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/switch-shipping-service-status", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "switch-shipping-service-status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PATCH — Accept Commission Terms", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/accept-commission-terms", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "accept-commission-terms" ] }, "description": "**Endpoint:** `PATCH /api/provider/accept-commission-terms`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/accept-commission-terms", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "accept-commission-terms" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/accept-commission-terms", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "accept-commission-terms" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/accept-commission-terms", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "accept-commission-terms" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/profile", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "profile" ] }, "description": "**Endpoint:** `GET /api/provider/settings/profile`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/profile", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/profile", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "profile" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/profile", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "profile" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Check Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/check-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "check-password" ] }, "description": "**Endpoint:** `POST /api/provider/settings/check-password`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\CheckPasswordRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `password` | `required\\|min:6\\|max:100` |", "body": { "mode": "raw", "raw": "{\n \"password\": \"Password@123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/check-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "check-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/check-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "check-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The password field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/check-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "check-password" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The password field is required.\",\n \"errors\": {\n \"password\": [\n \"The password field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/check-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "check-password" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/check-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "check-password" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PATCH — Update Password", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-password" ] }, "description": "**Endpoint:** `PATCH /api/provider/settings/update-password`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\UpdatePasswordRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `old_password` | `required\\|string\\|min:6\\|max:100` |\n| `password` | `required\\|string\\|min:6\\|max:100\\|confirmed` |", "body": { "mode": "raw", "raw": "{\n \"old_password\": \"Password@123\",\n \"password\": \"Password@123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The old_password field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-password" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The old_password field is required.\",\n \"errors\": {\n \"old_password\": [\n \"The old_password field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-password" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-password", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-password" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Update Provider Info", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-info", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-info" ] }, "description": "**Endpoint:** `POST /api/provider/settings/update-provider-info`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\UpdateProviderInfoRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `store_image` | `sometimes\\|image` |\n| `store_name` | `required\\|string\\|min:2\\|max:100\\|Unique` |\n| `name` | `required\\|string\\|min:2\\|max:100` |\n| `provider_activity_id` | `required\\|integer\\|exists:provider_activities,id` |\n| `city_id` | `required\\|integer\\|exists:cities,id` |\n| `district_id` | `required\\|integer\\|exists:districts,id` |\n| `street` | `required\\|string\\|min:2\\|max:191` |", "body": { "mode": "formdata", "formdata": [ { "key": "store_image", "type": "file", "src": [], "description": "Optional file" }, { "key": "store_name", "value": "Gold Store", "type": "text", "description": "Required" }, { "key": "name", "value": "Ahmed Ali", "type": "text", "description": "Required" }, { "key": "provider_activity_id", "value": "1", "type": "text", "description": "Required" }, { "key": "city_id", "value": "1", "type": "text", "description": "Required" }, { "key": "district_id", "value": "1", "type": "text", "description": "Required" }, { "key": "street", "value": "King Fahd Road", "type": "text", "description": "Required" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-info", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-info", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The store_name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-info", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-info" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The store_name field is required.\",\n \"errors\": {\n \"store_name\": [\n \"The store_name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-info", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-info" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-info", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-info" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Update Provider Store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-store" ] }, "description": "**Endpoint:** `POST /api/provider/settings/update-provider-store`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\UpdateProviderStoreRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `store_image` | `sometimes\\|image\\|mimes:jpeg,jpg,png,webp\\|max:2048` |\n| `store_name` | `sometimes\\|string\\|min:2\\|max:100\\|unique:providers,store_name,,id,deleted_at,NULL` |\n| `store_email` | `sometimes\\|email\\|max:100\\|unique:providers,store_email,,id,deleted_at,NULL` |\n| `description` | `sometimes\\|string\\|min:3\\|max:500` |\n| `city_id` | `sometimes\\|exists:cities,id` |\n| `lat` | `sometimes\\|max:50` |\n| `lng` | `sometimes\\|max:50` |\n| `map_desc` | `sometimes\\|max:191` |\n| `commercial_number` | `required_without:freelance_work_document_number\\|nullable\\|numeric\\|digits_between:10,20` |\n| `freelance_work_document_number` | `required_without:commercial_number\\|nullable\\|numeric\\|digits_between:10,20` |\n| `bank_name` | `sometimes\\|string\\|min:2\\|max:50` |\n| `bank_account_name` | `sometimes\\|string\\|min:2\\|max:50` |\n| `iban` | `sometimes\\|string\\|IbanRule\\|Unique` |\n| `commercial_register_file` | `sometimes\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `occupation_license_file` | `sometimes\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `profession_license_file` | `sometimes\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `shop_license_file` | `sometimes\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `stamp_certificate_file` | `sometimes\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |\n| `identity_file` | `sometimes\\|file\\|mimes:pdf,jpeg,jpg,png,webp\\|max:5120` |", "body": { "mode": "formdata", "formdata": [ { "key": "store_image", "type": "file", "src": [], "description": "Optional file" }, { "key": "store_name", "value": "Gold Store", "type": "text", "description": "Optional" }, { "key": "store_email", "value": "store@example.com", "type": "text", "description": "Optional" }, { "key": "description", "value": "Product description example", "type": "text", "description": "Optional" }, { "key": "city_id", "value": "1", "type": "text", "description": "Optional" }, { "key": "lat", "value": "24.7136", "type": "text", "description": "Optional" }, { "key": "lng", "value": "46.6753", "type": "text", "description": "Optional" }, { "key": "map_desc", "value": "Riyadh, Saudi Arabia", "type": "text", "description": "Optional" }, { "key": "commercial_number", "value": "1234567890", "type": "text", "description": "Required" }, { "key": "freelance_work_document_number", "value": "1", "type": "text", "description": "Required" }, { "key": "bank_name", "value": "Al Rajhi Bank", "type": "text", "description": "Optional" }, { "key": "bank_account_name", "value": "example", "type": "text", "description": "Optional" }, { "key": "iban", "value": "SA0380000000608010167519", "type": "text", "description": "Optional" }, { "key": "commercial_register_file", "type": "file", "src": [], "description": "Optional file" }, { "key": "occupation_license_file", "type": "file", "src": [], "description": "Optional file" }, { "key": "profession_license_file", "type": "file", "src": [], "description": "Optional file" }, { "key": "shop_license_file", "type": "file", "src": [], "description": "Optional file" }, { "key": "stamp_certificate_file", "type": "file", "src": [], "description": "Optional file" }, { "key": "identity_file", "type": "file", "src": [], "description": "Optional file" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-store" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The commercial_number field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-store" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The commercial_number field is required.\",\n \"errors\": {\n \"commercial_number\": [\n \"The commercial_number field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-store" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/update-provider-store", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "update-provider-store" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Old Phone Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-send-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-phone-old-phone-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Old Phone Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-check-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-phone-old-phone-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\ChangePhone\\ChangePhoneOldPhoneCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|digits:4` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-check-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-old-phone-check-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone New Phone Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-send-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-phone-new-phone-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\ChangePhone\\ChangePhoneNewPhoneRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|unique:providers,phone,,id,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The country_code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-send-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The country_code field is required.\",\n \"errors\": {\n \"country_code\": [\n \"The country_code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone New Phone Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-check-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-phone-new-phone-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\ChangePhone\\ChangePhoneNewPhoneCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|digits:4` |\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|unique:providers,phone,,id,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-check-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-new-phone-check-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Re Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-re-send-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-phone-re-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\ChangePhone\\ChangePhoneReSendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `nullable\\|numeric\\|digits_between:1,5` |\n| `phone` | `nullable\\|numeric\\|digits_between:9,10` |\n| `type` | `required\\|in:1,2` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"type\": \"1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-re-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-re-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The type field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-re-send-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The type field is required.\",\n \"errors\": {\n \"type\": [\n \"The type field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-re-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-phone-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-phone-re-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Email Old Email Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-send-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-email-old-email-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Email Old Email Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-check-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-email-old-email-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\ChangeEmail\\ChangeEmailOldEmailCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|digits:4` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-check-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-old-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-old-email-check-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Email New Email Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-send-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-email-new-email-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\ChangeEmail\\ChangeEmailNewEmailRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `store_email` | `required\\|email\\|max:50\\|unique:providers,store_email,,id,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"store_email\": \"store@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The store_email field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-send-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The store_email field is required.\",\n \"errors\": {\n \"store_email\": [\n \"The store_email field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Email New Email Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-check-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-email-new-email-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\ChangeEmail\\ChangeEmailNewEmailCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|digits:4` |\n| `store_email` | `required\\|email\\|max:50\\|unique:providers,store_email,,id,deleted_at,NULL` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"store_email\": \"store@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-check-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-new-email-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-new-email-check-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Email Re Send Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-re-send-code" ] }, "description": "**Endpoint:** `POST /api/provider/settings/change-email-re-send-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Profile\\ChangeEmail\\ChangeEmailReSendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `store_email` | `nullable\\|email\\|max:50\\|unique:providers,store_email,,id,deleted_at,NULL` |\n| `type` | `required\\|in:5,6` |", "body": { "mode": "raw", "raw": "{\n \"store_email\": \"store@example.com\",\n \"type\": \"5\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-re-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-re-send-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The type field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-re-send-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The type field is required.\",\n \"errors\": {\n \"type\": [\n \"The type field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-re-send-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settings/change-email-re-send-code", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settings", "change-email-re-send-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Profile & Settings" }, { "name": "Providers", "item": [ { "name": "PATCH — Change Lang", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "change-lang" ] }, "description": "**Endpoint:** `PATCH /api/provider/change-lang`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "change-lang" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "change-lang" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "change-lang" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Providers" }, { "name": "Reports & Statistics", "item": [ { "name": "POST — Index", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics" ] }, "description": "**Endpoint:** `POST /api/provider/reports-statistics`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\ReportsStatistics\\FilterReportsStatisticsRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `date_from` | `nullable\\|date` |\n| `date_to` | `nullable\\|date\\|after_or_equal:date_from` |\n| `feature_ids` | `nullable\\|array` |\n| `feature_ids.*.feature_id` | `nullable\\|integer\\|exists:features,id` |\n| `feature_ids.*.feature_option_id` | `required_if:feature_ids.*.feature_id,!=,null\\|integer\\|exists:feature_options,id` |\n| `highest_rated` | `nullable\\|in:true,1,false,0` |\n| `best_selling` | `nullable\\|in:true,1,false,0` |\n| `highest_price` | `nullable\\|in:true,1,false,0` |\n| `search` | `nullable\\|string\\|max:191` |", "body": { "mode": "raw", "raw": "{\n \"date_from\": \"2024-01-01\",\n \"date_to\": \"2024-12-31\",\n \"feature_ids\": [\n {\n \"feature_id\": 1,\n \"feature_option_id\": 1\n }\n ],\n \"highest_rated\": \"true\",\n \"best_selling\": \"true\",\n \"highest_price\": \"true\",\n \"search\": \"gold\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The date_from field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The date_from field is required.\",\n \"errors\": {\n \"date_from\": [\n \"The date_from field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Get Statistics By Type", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics-by-type", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics-by-type" ] }, "description": "**Endpoint:** `POST /api/provider/reports-statistics-by-type`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\ReportsStatistics\\GetStatisticsByTypeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `type` | `required\\|in:statistics_cards,financial_summary,products` |", "body": { "mode": "raw", "raw": "{\n \"type\": \"statistics_cards\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics-by-type", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics-by-type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics-by-type", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics-by-type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The type field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics-by-type", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics-by-type" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The type field is required.\",\n \"errors\": {\n \"type\": [\n \"The type field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics-by-type", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics-by-type" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/reports-statistics-by-type", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "reports-statistics-by-type" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Provider API — Reports & Statistics" }, { "name": "Settlements", "item": [ { "name": "GET — Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "index" ] }, "description": "**Endpoint:** `GET /api/provider/settlements/index`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "index" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "index" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/index", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "index" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Index Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/index-details", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "index-details" ] }, "description": "**Endpoint:** `GET /api/provider/settlements/index-details`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/index-details", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "index-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/index-details", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "index-details" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/index-details", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "index-details" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Send Settlement Request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/send-request", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "send-request" ] }, "description": "**Endpoint:** `POST /api/provider/settlements/send-request`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Provider\\Settlement\\SendSettlementRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `bank_name` | `required\\|string\\|min:2\\|max:50` |\n| `bank_account_name` | `required\\|string\\|min:2\\|max:50` |\n| `iban` | `required\\|string\\|IbanRule` |", "body": { "mode": "raw", "raw": "{\n \"bank_name\": \"Al Rajhi Bank\",\n \"bank_account_name\": \"example\",\n \"iban\": \"SA0380000000608010167519\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/send-request", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "send-request" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/send-request", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "send-request" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The bank_name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/send-request", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "send-request" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The bank_name field is required.\",\n \"errors\": {\n \"bank_name\": [\n \"The bank_name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/send-request", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "send-request" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/send-request", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "send-request" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Pending Settlements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/pending", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "pending" ] }, "description": "**Endpoint:** `GET /api/provider/settlements/pending`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/pending", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "pending" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/pending", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "pending" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/pending", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "pending" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Finished Settlements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/finished", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "finished" ] }, "description": "**Endpoint:** `GET /api/provider/settlements/finished`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/finished", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "finished" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/finished", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "finished" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/finished", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "finished" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Settlement Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/settlements/orders/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Settlement Orders Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders-details", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/provider/settlements/orders-details/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:provider, check-provider-status\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders-details", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders-details", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders-details", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/provider/settlements/orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "provider", "settlements", "orders-details", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Provider API — Settlements" } ], "description": "Provider (merchant) app API. Prefix: `{{base_url}}/api/provider`. Auth guard: `auth:provider`" }, { "name": "Delegate API", "item": [ { "name": "Authentication", "item": [ { "name": "POST — Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-in" ] }, "description": "**Endpoint:** `POST /api/delegate/sign-in`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Auth\\LoginRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10` |\n| `password` | `required\\|string\\|max:100` |\n| `device_id` | `required\\|max:250` |\n| `device_type` | `in:ios,android,web` |", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"password\": \"Password@123\",\n \"device_id\": \"device-uuid-12345\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-in" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-in" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The country_code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-in" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The country_code field is required.\",\n \"errors\": {\n \"country_code\": [\n \"The country_code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Need Active (203)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-in", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-in" ] } }, "status": "Non-Authoritative Information", "code": 203, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"needActive\",\n \"msg\": \"Account not activated\",\n \"data\": {\n \"phone\": \"512345678\",\n \"country_code\": \"966\"\n }\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "try {", " const res = pm.response.json();", " const token = res?.data?.token;", " if (token) {", " pm.collectionVariables.set('delegate_token', token);", " pm.environment.set('delegate_token', token);", " console.log('Saved delegate_token');", " }", "} catch (e) { console.warn(e); }" ] } } ] }, { "name": "POST — Activate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/activate", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "activate" ] }, "description": "**Endpoint:** `POST /api/delegate/activate`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Auth\\ActivateRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|max:10` |\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|exists:delegates,phone,deleted_at,NULL` |\n| `device_id` | `required\\|max:250` |\n| `device_type` | `in:ios,android,web` |\n| `mac_address` | `nullable\\|max:250` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"device_id\": \"device-uuid-12345\",\n \"device_type\": \"ios\",\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/activate", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/activate", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/activate", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "activate" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Need Active (203)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/activate", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "activate" ] } }, "status": "Non-Authoritative Information", "code": 203, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"needActive\",\n \"msg\": \"Account not activated\",\n \"data\": {\n \"phone\": \"512345678\",\n \"country_code\": \"966\"\n }\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "try {", " const res = pm.response.json();", " const token = res?.data?.token;", " if (token) {", " pm.collectionVariables.set('delegate_token', token);", " pm.environment.set('delegate_token', token);", " console.log('Saved delegate_token');", " }", "} catch (e) { console.warn(e); }" ] } } ] }, { "name": "DELETE — Logout", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-out" ] }, "description": "**Endpoint:** `DELETE /api/delegate/sign-out`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-out" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-out" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/sign-out", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "sign-out" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Delete Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-account", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-account" ] }, "description": "**Endpoint:** `POST /api/delegate/delete-account`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-account", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-account", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-account" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-account", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-account" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Delegate API — Authentication" }, { "name": "Complaints", "item": [ { "name": "POST — Store Complaint", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-complaint", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-complaint" ] }, "description": "**Endpoint:** `POST /api/delegate/store-complaint`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Auth\\StoreComplaintRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `subject` | `required\\|max:50` |\n| `complaint` | `required\\|max:500` |\n| `images` | `nullable\\|array` |\n| `images.*` | `nullable\\|image` |", "body": { "mode": "formdata", "formdata": [ { "key": "subject", "value": "example", "type": "text", "description": "Required" }, { "key": "complaint", "value": "Issue with delivery", "type": "text", "description": "Required" }, { "key": "images[0]", "type": "file", "src": [], "description": "Optional file" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-complaint", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-complaint" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-complaint", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-complaint" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The subject field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-complaint", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-complaint" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The subject field is required.\",\n \"errors\": {\n \"subject\": [\n \"The subject field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-complaint", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-complaint" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-complaint", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-complaint" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Send Contact Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-contact-message" ] }, "description": "**Endpoint:** `POST /api/delegate/store-contact-message`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Contact\\SendContactMessageRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `title` | `required\\|max:191` |\n| `subject` | `required\\|max:191` |", "body": { "mode": "raw", "raw": "{\n \"title\": \"Golden Ring\",\n \"subject\": \"example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-contact-message" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-contact-message" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The title field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-contact-message" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The title field is required.\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-contact-message" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/store-contact-message", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "store-contact-message" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Delegate API — Complaints" }, { "name": "Notifications", "item": [ { "name": "PATCH — Switch Notification Status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "switch-notify" ] }, "description": "**Endpoint:** `PATCH /api/delegate/switch-notify`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "switch-notify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "switch-notify" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/switch-notify", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "switch-notify" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Notifications With Limit", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "notifications-with-limit" ] }, "description": "**Endpoint:** `GET /api/delegate/notifications-with-limit`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "notifications-with-limit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "notifications-with-limit" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/notifications-with-limit", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "notifications-with-limit" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "notifications" ] }, "description": "**Endpoint:** `GET /api/delegate/notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Count Unread Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "count-notifications" ] }, "description": "**Endpoint:** `GET /api/delegate/count-notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "count-notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"count\": 3\n }\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "count-notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/count-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "count-notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "DELETE — Delete Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notification", ":notification_id" ], "variable": [ { "key": "notification_id", "value": "1", "description": "Path parameter: notification_id" } ] }, "description": "**Endpoint:** `DELETE /api/delegate/delete-notification/{notification_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notification", ":notification_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notification", ":notification_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notification", ":notification_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notification/:notification_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notification", ":notification_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "DELETE — Delete Notifications", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notifications" ] }, "description": "**Endpoint:** `DELETE /api/delegate/delete-notifications`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "delete-notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Delegate API — Notifications" }, { "name": "Order", "item": [ { "name": "Normal", "item": [ { "name": "GET — Order Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-details", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/order-details/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-details", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-details", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-details", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-details", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — New Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/new-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "new-orders" ] }, "description": "**Endpoint:** `GET /api/delegate/new-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/new-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "new-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/new-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "new-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/new-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "new-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — On Way Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/on-way-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "on-way-orders" ] }, "description": "**Endpoint:** `GET /api/delegate/on-way-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/on-way-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "on-way-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/on-way-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "on-way-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/on-way-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "on-way-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Finished Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finished-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finished-orders" ] }, "description": "**Endpoint:** `GET /api/delegate/finished-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finished-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finished-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finished-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finished-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finished-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finished-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Refuse Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-order", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/refuse-order/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-order", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-order", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-order", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-order", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Accept Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-order", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/accept-order/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-order", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-order", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-order", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-order", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Finish Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finish-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finish-order" ] }, "description": "**Endpoint:** `POST /api/delegate/finish-order`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Order\\FinishOrderRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `order_id` | `required\\|exists:orders,id,delegate_id,` |\n| `delivery_code` | `required\\|exists:orders,delivery_code,id,` |", "body": { "mode": "raw", "raw": "{\n \"order_id\": 1,\n \"delivery_code\": \"example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finish-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finish-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finish-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finish-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The order_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finish-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finish-order" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The order_id field is required.\",\n \"errors\": {\n \"order_id\": [\n \"The order_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finish-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finish-order" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finish-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finish-order" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Rate Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "rate-order" ] }, "description": "**Endpoint:** `POST /api/delegate/rate-order`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Order\\RateOrder`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `order_id` | `required\\|exists:orders,id,is_rated_delegate,0,delegate_id,` |\n| `provider_rate` | `required\\|min:1\\|max:5` |\n| `provider_comment` | `required\\|string\\|min:2` |\n| `user_rate` | `required\\|min:1\\|max:5` |\n| `user_comment` | `required\\|string\\|min:2` |", "body": { "mode": "raw", "raw": "{\n \"order_id\": 1,\n \"provider_rate\": \"example\",\n \"provider_comment\": \"example\",\n \"user_rate\": \"example\",\n \"user_comment\": \"example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "rate-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "rate-order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The order_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "rate-order" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The order_id field is required.\",\n \"errors\": {\n \"order_id\": [\n \"The order_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "rate-order" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/rate-order", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "rate-order" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Order Rates", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-rates/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-rates", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `POST /api/delegate/order-rates/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-rates/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-rates", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-rates/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-rates", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-rates/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-rates", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/order-rates/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "order-rates", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Approve Deliver From Provider", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/approve-deliver-from-provider/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "approve-deliver-from-provider", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/approve-deliver-from-provider/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/approve-deliver-from-provider/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "approve-deliver-from-provider", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/approve-deliver-from-provider/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "approve-deliver-from-provider", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/approve-deliver-from-provider/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "approve-deliver-from-provider", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/approve-deliver-from-provider/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "approve-deliver-from-provider", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Delegate API — Order / Normal" }, { "name": "Retrieval", "item": [ { "name": "GET — New Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/new-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "new-return-orders" ] }, "description": "**Endpoint:** `GET /api/delegate/new-return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/new-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "new-return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/new-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "new-return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/new-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "new-return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Receiving Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/receiving-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "receiving-return-orders" ] }, "description": "**Endpoint:** `GET /api/delegate/receiving-return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/receiving-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "receiving-return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/receiving-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "receiving-return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/receiving-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "receiving-return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Deliver To Provider Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-orders" ] }, "description": "**Endpoint:** `GET /api/delegate/deliver-to-provider-return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Finished Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finished-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finished-return-orders" ] }, "description": "**Endpoint:** `GET /api/delegate/finished-return-orders`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finished-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finished-return-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finished-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finished-return-orders" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/finished-return-orders", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "finished-return-orders" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/return-order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "return-order-details", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/return-order-details/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/return-order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "return-order-details", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/return-order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "return-order-details", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/return-order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "return-order-details", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/return-order-details/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "return-order-details", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Accept Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-return-order", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/accept-return-order/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-return-order", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-return-order", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-return-order", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/accept-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "accept-return-order", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Refuse Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-return-order", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/refuse-return-order/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-return-order", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-return-order", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-return-order", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/refuse-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "refuse-return-order", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Received From Customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/received-from-customer-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "received-from-customer-return-order", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/received-from-customer-return-order/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/received-from-customer-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "received-from-customer-return-order", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/received-from-customer-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "received-from-customer-return-order", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/received-from-customer-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "received-from-customer-return-order", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/received-from-customer-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "received-from-customer-return-order", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Deliver To Provider", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-order", ":order_id" ], "variable": [ { "key": "order_id", "value": "1", "description": "Path parameter: order_id" } ] }, "description": "**Endpoint:** `GET /api/delegate/deliver-to-provider-return-order/{order_id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-order", ":order_id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-order", ":order_id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-order", ":order_id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/deliver-to-provider-return-order/:order_id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "deliver-to-provider-return-order", ":order_id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Delegate API — Order / Retrieval" }, { "name": "Special", "item": [ { "name": "POST — Leajlak Webhook Actions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/leajlak_webhook", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "leajlak_webhook" ] }, "description": "**Endpoint:** `POST /api/delegate/leajlak_webhook`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Order\\LeajlakWebhookOrderActionsRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `dsp_order_id` | `required\\|string\\|Exists` |\n| `status` | `required\\|string\\|Exists` |\n| `driver.name` | `required\\|string` |\n| `driver.phone` | `required\\|string` |", "body": { "mode": "raw", "raw": "{\n \"dsp_order_id\": 1,\n \"status\": \"active\",\n \"driver\": {\n \"name\": \"Ahmed Ali\",\n \"phone\": \"512345678\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/leajlak_webhook", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "leajlak_webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/leajlak_webhook", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "leajlak_webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The dsp_order_id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/leajlak_webhook", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "leajlak_webhook" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The dsp_order_id field is required.\",\n \"errors\": {\n \"dsp_order_id\": [\n \"The dsp_order_id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] }, { "name": "POST — Leajlak Tracking Webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/leajlak_tracking_webhook", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "leajlak_tracking_webhook" ] }, "description": "**Endpoint:** `POST /api/delegate/leajlak_tracking_webhook`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Order\\LeajlakTrackingWebhookRequest`\n\n**Middleware:** api, api-cors, api-lang, guest:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `id` | `nullable\\|integer` |\n| `driver.latitude` | `nullable` |\n| `driver.longitude` | `nullable` |", "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"driver\": {\n \"latitude\": \"example\",\n \"longitude\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/leajlak_tracking_webhook", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "leajlak_tracking_webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/leajlak_tracking_webhook", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "leajlak_tracking_webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The id field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/api/delegate/leajlak_tracking_webhook", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "leajlak_tracking_webhook" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The id field is required.\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." } ] } ], "description": "Delegate API — Order / Special" } ], "description": "Delegate API — Order" }, { "name": "Pages", "item": [ { "name": "GET — About Delegate", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/about", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "about" ] }, "description": "**Endpoint:** `GET /api/delegate/about`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/about", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "about" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"title\": \"Page title\",\n \"content\": \"Page HTML\\/content\"\n }\n}" } ] }, { "name": "GET — Terms Delegate", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/terms", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "terms" ] }, "description": "**Endpoint:** `GET /api/delegate/terms`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/terms", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "terms" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"title\": \"Page title\",\n \"content\": \"Page HTML\\/content\"\n }\n}" } ] }, { "name": "GET — Privacy Delegate", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/privacy", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "privacy" ] }, "description": "**Endpoint:** `GET /api/delegate/privacy`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, OptionalSanctumMiddleware\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nOptional Bearer token — some fields/behavior may change when authenticated." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Optional Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/privacy", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "privacy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"title\": \"Page title\",\n \"content\": \"Page HTML\\/content\"\n }\n}" } ] } ], "description": "Delegate API — Pages" }, { "name": "Profile", "item": [ { "name": "POST — Complete Info", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "complete-info" ] }, "description": "**Endpoint:** `POST /api/delegate/complete-info`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Auth\\UpdateProfileRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `name` | `required\\|max:50` |\n| `email` | `required\\|email\\|max:50\\|unique:delegates,email,,id,deleted_at,NULL` |\n| `image` | `nullable\\|image` |\n| `lat` | `required\\|max:50` |\n| `lng` | `required\\|max:50` |\n| `map_desc` | `required\\|max:191` |\n| `licines_image` | `nullable\\|image` |\n| `identity_image` | `nullable\\|image` |\n| `city_id` | `required\\|exists:cities,id` |\n| `bank_name` | `required\\|max:50` |\n| `banke_account_name` | `required\\|max:50` |\n| `banke_account_number` | `required\\|max:50` |\n| `iban` | `required\\|max:50` |", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Ahmed Ali", "type": "text", "description": "Required" }, { "key": "email", "value": "user@example.com", "type": "text", "description": "Required" }, { "key": "image", "type": "file", "src": [], "description": "Optional file" }, { "key": "lat", "value": "24.7136", "type": "text", "description": "Required" }, { "key": "lng", "value": "46.6753", "type": "text", "description": "Required" }, { "key": "map_desc", "value": "Riyadh, Saudi Arabia", "type": "text", "description": "Required" }, { "key": "licines_image", "type": "file", "src": [], "description": "Optional file" }, { "key": "identity_image", "type": "file", "src": [], "description": "Optional file" }, { "key": "city_id", "value": "1", "type": "text", "description": "Required" }, { "key": "bank_name", "value": "Al Rajhi Bank", "type": "text", "description": "Required" }, { "key": "banke_account_name", "value": "example", "type": "text", "description": "Required" }, { "key": "banke_account_number", "value": "example", "type": "text", "description": "Required" }, { "key": "iban", "value": "SA0380000000608010167519", "type": "text", "description": "Required" } ] } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "complete-info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "complete-info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The name field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "complete-info" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "complete-info" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/complete-info", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "complete-info" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Get Profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/profile", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "profile" ] }, "description": "**Endpoint:** `GET /api/delegate/profile`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/profile", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/profile", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "profile" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/profile", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "profile" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PATCH — Change Lang", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-lang" ] }, "description": "**Endpoint:** `PATCH /api/delegate/change-lang`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-lang" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-lang" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-lang", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-lang" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "PATCH — Change Availability", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-availability", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-availability" ] }, "description": "**Endpoint:** `PATCH /api/delegate/change-availability`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-availability", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-availability" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-availability", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-availability" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-availability", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-availability" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Send Code To Old Phone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-old-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-old-phone" ] }, "description": "**Endpoint:** `POST /api/delegate/change-phone-send-code-to-old-phone`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-old-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-old-phone" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-old-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-old-phone" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-old-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-old-phone" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Old Phone Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-old-phone-check-code" ] }, "description": "**Endpoint:** `POST /api/delegate/change-phone-old-phone-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\User\\Profile\\ChangePhoneOldPhoneCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-old-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-old-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-old-phone-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-old-phone-check-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-old-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-old-phone-check-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone Send Code To New Phone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-new-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-new-phone" ] }, "description": "**Endpoint:** `POST /api/delegate/change-phone-send-code-to-new-phone`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Auth\\ChangePhoneSendCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required\\|numeric\\|digits:4` |\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|PhoneRule` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-new-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-new-phone" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-new-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-new-phone" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-new-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-new-phone" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-new-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-new-phone" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-send-code-to-new-phone", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-send-code-to-new-phone" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Change Phone New Phone Check Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-new-phone-check-code" ] }, "description": "**Endpoint:** `POST /api/delegate/change-phone-new-phone-check-code`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `App\\Http\\Requests\\Api\\Delegate\\Auth\\ChangePhoneCheckCodeRequest`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum).\n\n### Validation rules\n| Field | Rules |\n|---|---|\n| `code` | `required` |\n| `country_code` | `required\\|numeric\\|digits_between:1,5` |\n| `phone` | `required\\|numeric\\|digits_between:9,10\\|PhoneRule` |", "body": { "mode": "raw", "raw": "{\n \"code\": \"1234\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-new-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Validation Error (fail)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-new-phone-check-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"The code field is required.\"\n}", "description": "Project validation format via BaseRequest::failedValidation (key=fail, first error message)." }, { "name": "Validation Error (422)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-new-phone-check-code" ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}", "description": "Conventional Laravel 422 shape. This project normally returns key=fail instead." }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-new-phone-check-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/change-phone-new-phone-check-code", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "change-phone-new-phone-check-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Delegate API — Profile" }, { "name": "Settlements", "item": [ { "name": "GET — Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-index", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-index" ] }, "description": "**Endpoint:** `GET /api/delegate/settlement-index`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-index", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-index" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-index", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-index" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-index", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-index" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Index Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-index-details", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-index-details" ] }, "description": "**Endpoint:** `GET /api/delegate/settlement-index-details`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-index-details", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-index-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-index-details", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-index-details" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-index-details", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-index-details" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "POST — Send Settlement Request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-send-request", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-send-request" ] }, "description": "**Endpoint:** `POST /api/delegate/settlement-send-request`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-send-request", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-send-request" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-send-request", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-send-request" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-send-request", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-send-request" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Pending Settlements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-pending", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-pending" ] }, "description": "**Endpoint:** `GET /api/delegate/settlement-pending`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-pending", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-pending" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-pending", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-pending" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-pending", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-pending" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Finished Settlements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-finished", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-finished" ] }, "description": "**Endpoint:** `GET /api/delegate/settlement-finished`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-finished", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-finished" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-finished", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-finished" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-finished", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-finished" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] }, { "name": "GET — Settlement Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/delegate/settlement-orders/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "GET — Settlement Orders Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders-details", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `GET /api/delegate/settlement-orders-details/{id}`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders-details", ":id" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders-details", ":id" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders-details", ":id" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/settlement-orders-details/:id", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "settlement-orders-details", ":id" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Delegate API — Settlements" }, { "name": "Wallet", "item": [ { "name": "GET — Show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/show-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "show-wallet" ] }, "description": "**Endpoint:** `GET /api/delegate/show-wallet`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang, auth:sanctum, is-active-delegate\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message.\n\n### Authentication\nRequires `Authorization: Bearer {{token}}` (Sanctum)." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/show-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "show-wallet" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {\n \"balance\": 150.5\n }\n}" }, { "name": "Unauthenticated (401)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/show-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "show-wallet" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"Unauthenticated\"\n}" }, { "name": "Forbidden / Blocked (403)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" }, { "key": "Authorization", "value": "Bearer {{delegate_token}}", "type": "text", "description": "Required Sanctum token" } ], "url": { "raw": "{{base_url}}/api/delegate/show-wallet", "host": [ "{{base_url}}" ], "path": [ "api", "delegate", "show-wallet" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"blocked\",\n \"msg\": \"Your account has been blocked\"\n}" } ] } ], "description": "Delegate API — Wallet" } ], "description": "Delegate (delivery) app API. Prefix: `{{base_url}}/api/delegate`" }, { "name": "Admin API", "item": [ { "name": "Products", "item": [ { "name": "POST — Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/products/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "products", ":id", "approve" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/admin/products/{id}/approve`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/products/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "products", ":id", "approve" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/products/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "products", ":id", "approve" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Reject", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/products/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "products", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/admin/products/{id}/reject`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/products/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "products", ":id", "reject" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/products/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "products", ":id", "reject" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Admin API — Products" }, { "name": "Provider Registration", "item": [ { "name": "POST — Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", ":id", "approve" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/admin/providers/{id}/approve`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", ":id", "approve" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", ":id", "approve" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Reject", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/admin/providers/{id}/reject`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", ":id", "reject" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", ":id", "reject" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Admin API — Provider Registration" }, { "name": "Provider Updates", "item": [ { "name": "POST — Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/updates/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", "updates", ":id", "approve" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/admin/providers/updates/{id}/approve`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**Middleware:** api, api-cors, api-lang\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/updates/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", "updates", ":id", "approve" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/updates/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", "updates", ":id", "approve" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] }, { "name": "POST — Reject", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/updates/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", "updates", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter: id" } ] }, "description": "**Endpoint:** `POST /api/admin/providers/updates/{id}/reject`\n\n**Figma screen:** https://www.figma.com/proto/M5S22z2ySF5QjW2SQEykz4/%D8%A8%D9%88%D8%A7%D8%A8%D8%A9-%D8%A7%D9%84%D8%A7%D9%85%D8%AF%D8%A7%D8%AF-%D9%88-%D8%A7%D9%84%D8%AA%D9%85%D9%88%D9%8A%D9%86?node-id=15013-96&viewport=160%2C304%2C0.09&t=6dQ3GExihsEVAXsE-1&scaling=scale-down&content-scaling=fixed&starting-point-node-id=15013%3A384&page-id=15003%3A21\n\n**FormRequest:** `Illuminate\\Http\\Request`\n\n**Middleware:** api, api-cors, api-lang\n\n### Behavior\nReturns the project standard envelope: `{ \"key\": \"...\", \"msg\": \"...\", \"data\": ... }`.\nSuccess responses use `key=success`. Validation errors use `key=fail` with the first error message." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/updates/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", "updates", ":id", "reject" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم بنجاح\",\n \"data\": {}\n}" }, { "name": "Not Found (404)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Lang", "value": "{{lang}}", "type": "text", "description": "API language (ar|en)" } ], "url": { "raw": "{{base_url}}/api/admin/providers/updates/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "admin", "providers", "updates", ":id", "reject" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Not found\"\n}" } ] } ], "description": "Admin API — Provider Updates" } ], "description": "Admin API actions for providers/products. Prefix: `{{base_url}}/api/admin`" } ], "variable": [ { "key": "base_url", "value": "http://localhost", "type": "string" }, { "key": "lang", "value": "ar", "type": "string" }, { "key": "user_token", "value": "", "type": "string" }, { "key": "provider_token", "value": "", "type": "string" }, { "key": "delegate_token", "value": "", "type": "string" }, { "key": "admin_token", "value": "", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{user_token}}", "type": "string" } ] } }