{ "info": { "_postman_id": "a7c1f0e2-3b5d-4f6a-9c8e-markatty0001", "name": "Markatty Super Admin API", "description": "# Markatty Super Admin API (v1)\n\nAll routes are prefixed with `/api/v1/super` (already included in `{{base_url}}`).\n\n## Authentication\nLaravel Sanctum bearer tokens. Run **Auth → Login** first — its test script stores the returned token into the `token` environment variable, and the collection-level Bearer auth applies it to every request.\n\n## Response envelope\nSuccess: `{\"status\": \"Success\", \"message\": \"...\", \"data\": ...}`\nError: `{\"status\": \"Error\", \"message\": \"...\", \"data\": null}`\nValidation errors return HTTP 422 with `{\"message\": \"...\", \"errors\": {field: [..]}}`.\n(Exception: `DELETE /logout` returns a bare `{message}` — legacy parity.)\n\n## Localization\nSend `x-locale: ` header or `locale` query param to localize responses. Defaults to the default channel locale, then `en`. The `{{locale}}` environment variable is pre-wired into every request header.\n\n## Pagination\nList endpoints accept `per_page` (default 15) and return the standard Laravel paginator object inside `data`.\n\n## File uploads\nContent (videos, sliders, partners, clients, testimonials) and theme endpoints use `multipart/form-data`. Their **updates use `POST /{id}`** (not PUT) so files can be attached.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "item": [ { "name": "Auth", "description": "Authentication for super admins (Laravel Sanctum bearer tokens). Login stores the token into the environment automatically via a test script.", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/login", "host": [ "{{base_url}}" ], "path": [ "login" ] }, "description": "Authenticate a super admin and receive a Sanctum bearer token. The test script saves `data.token` to the `token` environment variable so all other requests work immediately.", "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@example.com\",\n \"password\": \"secret123\",\n \"device_name\": \"postman\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/login", "host": [ "{{base_url}}" ], "path": [ "login" ] }, "description": "Authenticate a super admin and receive a Sanctum bearer token. The test script saves `data.token` to the `token` environment variable so all other requests work immediately.", "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@example.com\",\n \"password\": \"secret123\",\n \"device_name\": \"postman\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Logged in successfully.\",\n \"data\": {\n \"agent\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"status\": 1,\n \"role_id\": 1,\n \"role\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"permission_type\": \"all\"\n },\n \"image_url\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n },\n \"token\": \"1|abcDEF123456789tokenExample\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/login", "host": [ "{{base_url}}" ], "path": [ "login" ] }, "description": "Authenticate a super admin and receive a Sanctum bearer token. The test script saves `data.token` to the `token` environment variable so all other requests work immediately.", "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@example.com\",\n \"password\": \"secret123\",\n \"device_name\": \"postman\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The email field is required.\",\n \"errors\": {\n \"email\": [\n \"The email field is required.\"\n ]\n }\n}" }, { "name": "Invalid Credentials", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/login", "host": [ "{{base_url}}" ], "path": [ "login" ] }, "description": "Authenticate a super admin and receive a Sanctum bearer token. The test script saves `data.token` to the `token` environment variable so all other requests work immediately.", "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@example.com\",\n \"password\": \"secret123\",\n \"device_name\": \"postman\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"These credentials do not match our records.\",\n \"data\": null\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const json = pm.response.json();", "if (json && json.data && json.data.token) {", " pm.environment.set(\"token\", json.data.token);", " console.log(\"Token saved to environment.\");", "}" ] } } ] }, { "name": "Forgot Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/forgot-password", "host": [ "{{base_url}}" ], "path": [ "forgot-password" ] }, "description": "Send a password reset link to the given super admin email.", "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/forgot-password", "host": [ "{{base_url}}" ], "path": [ "forgot-password" ] }, "description": "Send a password reset link to the given super admin email.", "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Reset link sent to your email.\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/forgot-password", "host": [ "{{base_url}}" ], "path": [ "forgot-password" ] }, "description": "Send a password reset link to the given super admin email.", "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The email field is required.\",\n \"errors\": {\n \"email\": [\n \"The email field is required.\"\n ]\n }\n}" } ] }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/reset-password", "host": [ "{{base_url}}" ], "path": [ "reset-password" ] }, "description": "Reset the password using the token from the reset email. `password` must be confirmed (send `password_confirmation`).", "body": { "mode": "raw", "raw": "{\n \"token\": \"reset-token-from-email\",\n \"email\": \"admin@example.com\",\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/reset-password", "host": [ "{{base_url}}" ], "path": [ "reset-password" ] }, "description": "Reset the password using the token from the reset email. `password` must be confirmed (send `password_confirmation`).", "body": { "mode": "raw", "raw": "{\n \"token\": \"reset-token-from-email\",\n \"email\": \"admin@example.com\",\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Password reset successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/reset-password", "host": [ "{{base_url}}" ], "path": [ "reset-password" ] }, "description": "Reset the password using the token from the reset email. `password` must be confirmed (send `password_confirmation`).", "body": { "mode": "raw", "raw": "{\n \"token\": \"reset-token-from-email\",\n \"email\": \"admin@example.com\",\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The token field is required.\",\n \"errors\": {\n \"token\": [\n \"The token field is required.\"\n ]\n }\n}" } ] }, { "name": "Logout", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/logout", "host": [ "{{base_url}}" ], "path": [ "logout" ] }, "description": "Revoke the current access token. Returns a bare `{message}` payload (legacy parity, no envelope)." }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/logout", "host": [ "{{base_url}}" ], "path": [ "logout" ] }, "description": "Revoke the current access token. Returns a bare `{message}` payload (legacy parity, no envelope)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Logged out successfully.\"\n}" }, { "name": "Unauthenticated", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/logout", "host": [ "{{base_url}}" ], "path": [ "logout" ] }, "description": "Revoke the current access token. Returns a bare `{message}` payload (legacy parity, no envelope)." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Unauthenticated.\"\n}" } ] }, { "name": "Get Account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] }, "description": "Get the authenticated super admin profile." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] }, "description": "Get the authenticated super admin profile." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"status\": 1,\n \"role_id\": 1,\n \"role\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"permission_type\": \"all\"\n },\n \"image_url\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Unauthenticated", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] }, "description": "Get the authenticated super admin profile." }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Unauthenticated.\"\n}" } ] }, { "name": "Update Account", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] }, "description": "Update the authenticated super admin profile. `old_password` is required only when changing the password.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"old_password\": \"secret123\",\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] }, "description": "Update the authenticated super admin profile. `old_password` is required only when changing the password.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"old_password\": \"secret123\",\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Account updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"status\": 1,\n \"role_id\": 1,\n \"role\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"permission_type\": \"all\"\n },\n \"image_url\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] }, "description": "Update the authenticated super admin profile. `old_password` is required only when changing the password.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"old_password\": \"secret123\",\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The first_name field is required.\",\n \"errors\": {\n \"first_name\": [\n \"The first_name field is required.\"\n ]\n }\n}" } ] } ] }, { "name": "Dashboard", "description": "High-level KPIs for the super admin dashboard.", "item": [ { "name": "Dashboard Overview", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/dashboard", "host": [ "{{base_url}}" ], "path": [ "dashboard" ] }, "description": "Aggregate dashboard metrics: tenants, revenue, subscriptions, etc." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/dashboard", "host": [ "{{base_url}}" ], "path": [ "dashboard" ] }, "description": "Aggregate dashboard metrics: tenants, revenue, subscriptions, etc." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"total_companies\": 120,\n \"active_companies\": 98,\n \"inactive_companies\": 22,\n \"total_revenue\": \"45230.50\",\n \"active_subscriptions\": 85,\n \"new_companies_this_month\": 12\n }\n}" } ] }, { "name": "Top Companies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/dashboard/top-companies?limit=10&start_date=2026-06-20&end_date=2026-07-20", "host": [ "{{base_url}}" ], "path": [ "dashboard", "top-companies" ], "query": [ { "key": "limit", "value": "10", "description": "Number of companies to return (default 10)", "disabled": true }, { "key": "start_date", "value": "2026-06-20", "description": "Start of range (default: 30 days ago)", "disabled": true }, { "key": "end_date", "value": "2026-07-20", "description": "End of range (default: now)", "disabled": true } ] }, "description": "Top companies by performance within a date range." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/dashboard/top-companies?limit=10&start_date=2026-06-20&end_date=2026-07-20", "host": [ "{{base_url}}" ], "path": [ "dashboard", "top-companies" ], "query": [ { "key": "limit", "value": "10", "description": "Number of companies to return (default 10)", "disabled": true }, { "key": "start_date", "value": "2026-06-20", "description": "Start of range (default: 30 days ago)", "disabled": true }, { "key": "end_date", "value": "2026-07-20", "description": "End of range (default: now)", "disabled": true } ] }, "description": "Top companies by performance within a date range." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"company_id\": 1,\n \"name\": \"Acme Store\",\n \"orders_count\": 320,\n \"grand_total\": \"15230.00\"\n }\n ]\n}" } ] } ] }, { "name": "Statistics", "description": "Cross-tenant reporting endpoints. All list endpoints support `per_page` and `search`.", "item": [ { "name": "Customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/customers?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "customers" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Customer counts per tenant." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/customers?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "customers" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Customer counts per tenant." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"company_id\": 1,\n \"company_name\": \"Acme Store\",\n \"customers_count\": 540\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/products?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "products" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Product counts per tenant." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/products?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "products" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Product counts per tenant." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"company_id\": 1,\n \"company_name\": \"Acme Store\",\n \"products_count\": 230\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/orders?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "orders" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Order counts and totals per tenant." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/orders?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "orders" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Order counts and totals per tenant." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"company_id\": 1,\n \"company_name\": \"Acme Store\",\n \"orders_count\": 320,\n \"completed_orders\": 290,\n \"grand_total\": \"15230.00\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/details?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "details" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Combined per-tenant detail statistics." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/details?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "details" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Combined per-tenant detail statistics." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"company_id\": 1,\n \"company_name\": \"Acme Store\",\n \"customers_count\": 540,\n \"products_count\": 230,\n \"orders_count\": 320,\n \"grand_total\": \"15230.00\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Statistics Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/statistics", "host": [ "{{base_url}}" ], "path": [ "statistics", "statistics" ] }, "description": "All-time aggregate statistics across tenants." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/statistics", "host": [ "{{base_url}}" ], "path": [ "statistics", "statistics" ] }, "description": "All-time aggregate statistics across tenants." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"total_customers\": 15400,\n \"total_products\": 8300,\n \"total_orders\": 21000,\n \"total_grand_total\": \"983200.00\"\n }\n}" } ] }, { "name": "Plans History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/plans-history?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "plans-history" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "History of plan purchases across tenants." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/plans-history?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "statistics", "plans-history" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "History of plan purchases across tenants." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"company_id\": 1,\n \"company_name\": \"Acme Store\",\n \"plan_name\": \"Professional\",\n \"amount\": \"29.99\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Companies Using Payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/companies-using-payments?per_page=15&search=&payment_method=", "host": [ "{{base_url}}" ], "path": [ "statistics", "companies-using-payments" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true }, { "key": "payment_method", "value": "", "description": "Filter by payment method code", "disabled": true } ] }, "description": "Companies with configured/active payment methods." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/companies-using-payments?per_page=15&search=&payment_method=", "host": [ "{{base_url}}" ], "path": [ "statistics", "companies-using-payments" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true }, { "key": "payment_method", "value": "", "description": "Filter by payment method code", "disabled": true } ] }, "description": "Companies with configured/active payment methods." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"company_id\": 1,\n \"company_name\": \"Acme Store\",\n \"payment_methods\": [\n \"stripe\",\n \"cashondelivery\"\n ]\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Companies Using Carriers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/companies-using-carriers?per_page=15&search=&carrier_method=", "host": [ "{{base_url}}" ], "path": [ "statistics", "companies-using-carriers" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true }, { "key": "carrier_method", "value": "", "description": "Filter by carrier code", "disabled": true } ] }, "description": "Companies with configured/active shipping carriers." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/companies-using-carriers?per_page=15&search=&carrier_method=", "host": [ "{{base_url}}" ], "path": [ "statistics", "companies-using-carriers" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true }, { "key": "carrier_method", "value": "", "description": "Filter by carrier code", "disabled": true } ] }, "description": "Companies with configured/active shipping carriers." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"company_id\": 1,\n \"company_name\": \"Acme Store\",\n \"carrier_methods\": [\n \"flatrate\",\n \"aramex\"\n ]\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Payment Filter Options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/payment-filter-options", "host": [ "{{base_url}}" ], "path": [ "statistics", "payment-filter-options" ] }, "description": "Distinct payment methods for filter dropdowns." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/payment-filter-options", "host": [ "{{base_url}}" ], "path": [ "statistics", "payment-filter-options" ] }, "description": "Distinct payment methods for filter dropdowns." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Payment filter options retrieved successfully\",\n \"data\": {\n \"payment_methods\": [\n \"stripe\",\n \"paypal\",\n \"cashondelivery\"\n ]\n }\n}" } ] }, { "name": "Carrier Filter Options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/carrier-filter-options", "host": [ "{{base_url}}" ], "path": [ "statistics", "carrier-filter-options" ] }, "description": "Distinct carrier methods for filter dropdowns." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/carrier-filter-options", "host": [ "{{base_url}}" ], "path": [ "statistics", "carrier-filter-options" ] }, "description": "Distinct carrier methods for filter dropdowns." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Carrier filter options retrieved successfully\",\n \"data\": {\n \"carrier_methods\": [\n \"flatrate\",\n \"aramex\",\n \"dhl\"\n ]\n }\n}" } ] }, { "name": "Charts: Payments & Carriers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/charts-payments-carriers", "host": [ "{{base_url}}" ], "path": [ "statistics", "charts-payments-carriers" ] }, "description": "Chart data of payment/carrier adoption." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/charts-payments-carriers", "host": [ "{{base_url}}" ], "path": [ "statistics", "charts-payments-carriers" ] }, "description": "Chart data of payment/carrier adoption." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Charts data for payments and carriers\",\n \"data\": {\n \"payments\": [\n {\n \"method\": \"stripe\",\n \"companies\": 40\n }\n ],\n \"carriers\": [\n {\n \"method\": \"flatrate\",\n \"companies\": 75\n }\n ]\n }\n}" } ] }, { "name": "Charts: Grand Total", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/charts-grand-total", "host": [ "{{base_url}}" ], "path": [ "statistics", "charts-grand-total" ] }, "description": "Chart data of grand totals over time." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/statistics/charts-grand-total", "host": [ "{{base_url}}" ], "path": [ "statistics", "charts-grand-total" ] }, "description": "Chart data of grand totals over time." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Charts data for grand totals\",\n \"data\": [\n {\n \"month\": \"2026-01\",\n \"grand_total\": \"45230.00\"\n },\n {\n \"month\": \"2026-02\",\n \"grand_total\": \"51200.00\"\n }\n ]\n}" } ] } ] }, { "name": "Analytics", "description": "Storefront tracking code (e.g. Google Analytics snippet) injected into tenant storefronts.", "item": [ { "name": "Get Analytics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/analytics", "host": [ "{{base_url}}" ], "path": [ "analytics" ] }, "description": "Get the current analytics/tracking snippet." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/analytics", "host": [ "{{base_url}}" ], "path": [ "analytics" ] }, "description": "Get the current analytics/tracking snippet." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"analytics\": \"\"\n }\n}" } ] }, { "name": "Set Analytics", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/analytics", "host": [ "{{base_url}}" ], "path": [ "analytics" ] }, "description": "Store the analytics/tracking snippet.", "body": { "mode": "raw", "raw": "{\n \"analytics\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/analytics", "host": [ "{{base_url}}" ], "path": [ "analytics" ] }, "description": "Store the analytics/tracking snippet.", "body": { "mode": "raw", "raw": "{\n \"analytics\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Analytics saved successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/analytics", "host": [ "{{base_url}}" ], "path": [ "analytics" ] }, "description": "Store the analytics/tracking snippet.", "body": { "mode": "raw", "raw": "{\n \"analytics\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The analytics field is required.\",\n \"errors\": {\n \"analytics\": [\n \"The analytics field is required.\"\n ]\n }\n}" } ] } ] }, { "name": "Tenants", "description": "Tenant (company) management: CRUD, cloning, impersonation, status toggling.", "item": [ { "name": "List Tenants", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants?per_page=15&search=&status=1&reliable=1", "host": [ "{{base_url}}" ], "path": [ "tenants" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true }, { "key": "status", "value": "1", "description": "Filter by active status (1/0)", "disabled": true }, { "key": "reliable", "value": "1", "description": "Filter by reliable flag (1/0)", "disabled": true } ] }, "description": "Paginated tenant list with optional search/status/reliable filters." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants?per_page=15&search=&status=1&reliable=1", "host": [ "{{base_url}}" ], "path": [ "tenants" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true }, { "key": "status", "value": "1", "description": "Filter by active status (1/0)", "disabled": true }, { "key": "reliable", "value": "1", "description": "Filter by reliable flag (1/0)", "disabled": true } ] }, "description": "Paginated tenant list with optional search/status/reliable filters." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"cname\": null,\n \"username\": \"acme\",\n \"is_active\": 1,\n \"reliable\": 1,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Tenant", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants", "host": [ "{{base_url}}" ], "path": [ "tenants" ] }, "description": "Create a new tenant (company) with its admin credentials.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"username\": \"acme\",\n \"password\": \"secret123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants", "host": [ "{{base_url}}" ], "path": [ "tenants" ] }, "description": "Create a new tenant (company) with its admin credentials.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"username\": \"acme\",\n \"password\": \"secret123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Tenant created successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"cname\": null,\n \"username\": \"acme\",\n \"is_active\": 1,\n \"reliable\": 1,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants", "host": [ "{{base_url}}" ], "path": [ "tenants" ] }, "description": "Create a new tenant (company) with its admin credentials.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"username\": \"acme\",\n \"password\": \"secret123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}" } ] }, { "name": "Mass Delete Tenants", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/mass-delete", "host": [ "{{base_url}}" ], "path": [ "tenants", "mass-delete" ] }, "description": "Soft-delete multiple tenants by id.", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 1,\n 2,\n 3\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/mass-delete", "host": [ "{{base_url}}" ], "path": [ "tenants", "mass-delete" ] }, "description": "Soft-delete multiple tenants by id.", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 1,\n 2,\n 3\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Tenants deleted successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/mass-delete", "host": [ "{{base_url}}" ], "path": [ "tenants", "mass-delete" ] }, "description": "Soft-delete multiple tenants by id.", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 1,\n 2,\n 3\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The ids field is required.\",\n \"errors\": {\n \"ids\": [\n \"The ids field is required.\"\n ]\n }\n}" } ] }, { "name": "Clone Store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/clone-store", "host": [ "{{base_url}}" ], "path": [ "tenants", "clone-store" ] }, "description": "Clone one tenant store into another (theme, settings, catalog as implemented by the clone service).", "body": { "mode": "raw", "raw": "{\n \"source_company_id\": 1,\n \"target_company_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/clone-store", "host": [ "{{base_url}}" ], "path": [ "tenants", "clone-store" ] }, "description": "Clone one tenant store into another (theme, settings, catalog as implemented by the clone service).", "body": { "mode": "raw", "raw": "{\n \"source_company_id\": 1,\n \"target_company_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Store cloned successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/clone-store", "host": [ "{{base_url}}" ], "path": [ "tenants", "clone-store" ] }, "description": "Clone one tenant store into another (theme, settings, catalog as implemented by the clone service).", "body": { "mode": "raw", "raw": "{\n \"source_company_id\": 1,\n \"target_company_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The source_company_id field is required.\",\n \"errors\": {\n \"source_company_id\": [\n \"The source_company_id field is required.\"\n ]\n }\n}" } ] }, { "name": "Sync Tenants", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/sync", "host": [ "{{base_url}}" ], "path": [ "tenants", "sync" ] }, "description": "Re-index tenants into the read model (TenantIndexer)." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/sync", "host": [ "{{base_url}}" ], "path": [ "tenants", "sync" ] }, "description": "Re-index tenants into the read model (TenantIndexer)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Tenants synced successfully\",\n \"data\": null\n}" } ] }, { "name": "Show Tenant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get a single tenant by id." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get a single tenant by id." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"cname\": null,\n \"username\": \"acme\",\n \"is_active\": 1,\n \"reliable\": 1,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get a single tenant by id." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Tenant", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Update tenant details.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"cname\": null,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Update tenant details.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"cname\": null,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Tenant updated successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"cname\": null,\n \"username\": \"acme\",\n \"is_active\": 1,\n \"reliable\": 1,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Update tenant details.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Store\",\n \"email\": \"owner@acme-store.com\",\n \"domain\": \"acme.markatty.com\",\n \"cname\": null,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}" } ] }, { "name": "Delete Tenant", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Soft-delete a tenant." }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Soft-delete a tenant." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Tenant deleted successfully\",\n \"data\": null\n}" } ] }, { "name": "Tenant Stats", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/stats", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "stats" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Per-tenant statistics (orders, customers, products, revenue)." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/stats", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "stats" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Per-tenant statistics (orders, customers, products, revenue)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"customers_count\": 540,\n \"products_count\": 230,\n \"orders_count\": 320,\n \"grand_total\": \"15230.00\"\n }\n}" } ] }, { "name": "Login As Tenant Admin", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/login-as-admin", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "login-as-admin" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Impersonate the tenant admin — returns a redirect URL/token to their admin panel." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/login-as-admin", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "login-as-admin" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Impersonate the tenant admin — returns a redirect URL/token to their admin panel." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Login link generated\",\n \"data\": {\n \"redirect_url\": \"https://acme.markatty.com/admin/login?token=one-time-token\"\n }\n}" } ] }, { "name": "Toggle Tenant Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/toggle-status", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "toggle-status" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Toggle the tenant active/inactive." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/toggle-status", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "toggle-status" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Toggle the tenant active/inactive." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Tenant status updated\",\n \"data\": {\n \"is_active\": 0\n }\n}" } ] }, { "name": "Reset Tenant Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/reset-password", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "reset-password" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Set a new password for the tenant's admin user.", "body": { "mode": "raw", "raw": "{\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/reset-password", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "reset-password" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Set a new password for the tenant's admin user.", "body": { "mode": "raw", "raw": "{\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Password reset successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/reset-password", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "reset-password" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Set a new password for the tenant's admin user.", "body": { "mode": "raw", "raw": "{\n \"password\": \"newSecret123\",\n \"password_confirmation\": \"newSecret123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The password field is required.\",\n \"errors\": {\n \"password\": [\n \"The password field is required.\"\n ]\n }\n}" } ] }, { "name": "Permanent Delete Tenant", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/permanent-delete", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "permanent-delete" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "PERMANENTLY delete a tenant and all of its data. Irreversible." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/tenants/:id/permanent-delete", "host": [ "{{base_url}}" ], "path": [ "tenants", ":id", "permanent-delete" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "PERMANENTLY delete a tenant and all of its data. Irreversible." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Tenant permanently deleted\",\n \"data\": null\n}" } ] } ] }, { "name": "Domains", "description": "Domain management via cPanel.", "item": [ { "name": "List Domains", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/domains", "host": [ "{{base_url}}" ], "path": [ "domains" ] }, "description": "List domains configured in cPanel." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/domains", "host": [ "{{base_url}}" ], "path": [ "domains" ] }, "description": "List domains configured in cPanel." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"domain\": \"acme.markatty.com\",\n \"docroot\": \"/home/markatty/public_html\"\n }\n ]\n}" } ] }, { "name": "Update Domain", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/domains", "host": [ "{{base_url}}" ], "path": [ "domains" ] }, "description": "Update a domain docroot in cPanel.", "body": { "mode": "raw", "raw": "{\n \"domain\": \"acme.markatty.com\",\n \"docroot\": \"/home/markatty/public_html\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/domains", "host": [ "{{base_url}}" ], "path": [ "domains" ] }, "description": "Update a domain docroot in cPanel.", "body": { "mode": "raw", "raw": "{\n \"domain\": \"acme.markatty.com\",\n \"docroot\": \"/home/markatty/public_html\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Domain updated successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/domains", "host": [ "{{base_url}}" ], "path": [ "domains" ] }, "description": "Update a domain docroot in cPanel.", "body": { "mode": "raw", "raw": "{\n \"domain\": \"acme.markatty.com\",\n \"docroot\": \"/home/markatty/public_html\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The domain field is required.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required.\"\n ]\n }\n}" } ] } ] }, { "name": "Agents", "description": "Super admin users (agents) CRUD.", "item": [ { "name": "List Agents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "agents" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Paginated list of super admin agents." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "agents" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Paginated list of super admin agents." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"status\": 1,\n \"role_id\": 1,\n \"role\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"permission_type\": \"all\"\n },\n \"image_url\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Agent", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents", "host": [ "{{base_url}}" ], "path": [ "agents" ] }, "description": "Create a super admin agent.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john@example.com\",\n \"password\": \"secret123\",\n \"password_confirmation\": \"secret123\",\n \"role_id\": 1,\n \"status\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents", "host": [ "{{base_url}}" ], "path": [ "agents" ] }, "description": "Create a super admin agent.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john@example.com\",\n \"password\": \"secret123\",\n \"password_confirmation\": \"secret123\",\n \"role_id\": 1,\n \"status\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Agent created successfully\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"status\": 1,\n \"role_id\": 1,\n \"role\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"permission_type\": \"all\"\n },\n \"image_url\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents", "host": [ "{{base_url}}" ], "path": [ "agents" ] }, "description": "Create a super admin agent.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john@example.com\",\n \"password\": \"secret123\",\n \"password_confirmation\": \"secret123\",\n \"role_id\": 1,\n \"status\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The email field is required.\",\n \"errors\": {\n \"email\": [\n \"The email field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Agent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents/:id", "host": [ "{{base_url}}" ], "path": [ "agents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get one agent." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents/:id", "host": [ "{{base_url}}" ], "path": [ "agents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get one agent." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"status\": 1,\n \"role_id\": 1,\n \"role\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"permission_type\": \"all\"\n },\n \"image_url\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents/:id", "host": [ "{{base_url}}" ], "path": [ "agents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get one agent." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Agent", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents/:id", "host": [ "{{base_url}}" ], "path": [ "agents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Update an agent. Password is optional; when sent it must be confirmed.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john@example.com\",\n \"password\": null,\n \"role_id\": 1,\n \"status\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents/:id", "host": [ "{{base_url}}" ], "path": [ "agents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Update an agent. Password is optional; when sent it must be confirmed.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john@example.com\",\n \"password\": null,\n \"role_id\": 1,\n \"status\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Agent updated successfully\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\",\n \"email\": \"admin@example.com\",\n \"status\": 1,\n \"role_id\": 1,\n \"role\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"permission_type\": \"all\"\n },\n \"image_url\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents/:id", "host": [ "{{base_url}}" ], "path": [ "agents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Update an agent. Password is optional; when sent it must be confirmed.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john@example.com\",\n \"password\": null,\n \"role_id\": 1,\n \"status\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The email field is required.\",\n \"errors\": {\n \"email\": [\n \"The email field is required.\"\n ]\n }\n}" } ] }, { "name": "Delete Agent", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents/:id", "host": [ "{{base_url}}" ], "path": [ "agents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Delete an agent." }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/agents/:id", "host": [ "{{base_url}}" ], "path": [ "agents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Delete an agent." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Agent deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Roles", "description": "Super admin roles and permissions (ACL).", "item": [ { "name": "List Roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "roles" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Paginated list of roles." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "roles" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "Paginated list of roles." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"description\": \"Full access role\",\n \"permission_type\": \"all\",\n \"permissions\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Role", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles", "host": [ "{{base_url}}" ], "path": [ "roles" ] }, "description": "Create a role. `permission_type` is `all` or `custom`; when custom, send the `permissions` array of ACL keys.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Agent\",\n \"description\": \"Can view tenants and reply to tickets\",\n \"permission_type\": \"custom\",\n \"permissions\": [\n \"tenants.view\",\n \"support.view\",\n \"support.reply\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles", "host": [ "{{base_url}}" ], "path": [ "roles" ] }, "description": "Create a role. `permission_type` is `all` or `custom`; when custom, send the `permissions` array of ACL keys.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Agent\",\n \"description\": \"Can view tenants and reply to tickets\",\n \"permission_type\": \"custom\",\n \"permissions\": [\n \"tenants.view\",\n \"support.view\",\n \"support.reply\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Role created successfully\",\n \"data\": {\n \"id\": 2,\n \"name\": \"Support Agent\",\n \"description\": \"Full access role\",\n \"permission_type\": \"custom\",\n \"permissions\": [\n \"tenants.view\",\n \"support.view\",\n \"support.reply\"\n ],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles", "host": [ "{{base_url}}" ], "path": [ "roles" ] }, "description": "Create a role. `permission_type` is `all` or `custom`; when custom, send the `permissions` array of ACL keys.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Agent\",\n \"description\": \"Can view tenants and reply to tickets\",\n \"permission_type\": \"custom\",\n \"permissions\": [\n \"tenants.view\",\n \"support.view\",\n \"support.reply\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}" } ] }, { "name": "Get ACL Tree", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/acl", "host": [ "{{base_url}}" ], "path": [ "roles", "acl" ] }, "description": "Full ACL permission tree used to build the role form." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/acl", "host": [ "{{base_url}}" ], "path": [ "roles", "acl" ] }, "description": "Full ACL permission tree used to build the role form." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"key\": \"tenants\",\n \"name\": \"Tenants\",\n \"children\": [\n {\n \"key\": \"tenants.view\",\n \"name\": \"View\"\n },\n {\n \"key\": \"tenants.create\",\n \"name\": \"Create\"\n }\n ]\n }\n ]\n}" } ] }, { "name": "Show Role", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/:id", "host": [ "{{base_url}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get one role." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/:id", "host": [ "{{base_url}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get one role." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"description\": \"Full access role\",\n \"permission_type\": \"all\",\n \"permissions\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/:id", "host": [ "{{base_url}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Get one role." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Role", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/:id", "host": [ "{{base_url}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Agent\",\n \"description\": \"Updated description\",\n \"permission_type\": \"custom\",\n \"permissions\": [\n \"tenants.view\",\n \"support.view\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/:id", "host": [ "{{base_url}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Agent\",\n \"description\": \"Updated description\",\n \"permission_type\": \"custom\",\n \"permissions\": [\n \"tenants.view\",\n \"support.view\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Role updated successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Administrator\",\n \"description\": \"Full access role\",\n \"permission_type\": \"all\",\n \"permissions\": null,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/:id", "host": [ "{{base_url}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Agent\",\n \"description\": \"Updated description\",\n \"permission_type\": \"custom\",\n \"permissions\": [\n \"tenants.view\",\n \"support.view\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}" } ] }, { "name": "Delete Role", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/:id", "host": [ "{{base_url}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Delete a role (fails if agents are assigned)." }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/roles/:id", "host": [ "{{base_url}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Delete a role (fails if agents are assigned)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Role deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Locales", "description": "Platform locales CRUD.", "item": [ { "name": "List Locales", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "locales" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "locales" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"direction\": \"ltr\"\n },\n {\n \"id\": 2,\n \"code\": \"ar\",\n \"name\": \"Arabic\",\n \"direction\": \"rtl\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 2,\n \"total\": 2\n }\n}" } ] }, { "name": "Create Locale", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales", "host": [ "{{base_url}}" ], "path": [ "locales" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"fr\",\n \"name\": \"French\",\n \"direction\": \"ltr\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales", "host": [ "{{base_url}}" ], "path": [ "locales" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"fr\",\n \"name\": \"French\",\n \"direction\": \"ltr\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Locale created successfully\",\n \"data\": {\n \"id\": 3,\n \"code\": \"fr\",\n \"name\": \"French\",\n \"direction\": \"ltr\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales", "host": [ "{{base_url}}" ], "path": [ "locales" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"fr\",\n \"name\": \"French\",\n \"direction\": \"ltr\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Locale", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales/:id", "host": [ "{{base_url}}" ], "path": [ "locales", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales/:id", "host": [ "{{base_url}}" ], "path": [ "locales", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"direction\": \"ltr\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales/:id", "host": [ "{{base_url}}" ], "path": [ "locales", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Locale", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales/:id", "host": [ "{{base_url}}" ], "path": [ "locales", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"en\",\n \"name\": \"English (US)\",\n \"direction\": \"ltr\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales/:id", "host": [ "{{base_url}}" ], "path": [ "locales", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"en\",\n \"name\": \"English (US)\",\n \"direction\": \"ltr\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Locale updated successfully\",\n \"data\": {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"direction\": \"ltr\"\n }\n}" } ] }, { "name": "Delete Locale", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales/:id", "host": [ "{{base_url}}" ], "path": [ "locales", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/locales/:id", "host": [ "{{base_url}}" ], "path": [ "locales", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Locale deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Currencies", "description": "Platform currencies CRUD.", "item": [ { "name": "List Currencies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "currencies" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies?per_page=15&search=", "host": [ "{{base_url}}" ], "path": [ "currencies" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"symbol\": \"$\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Currency", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies", "host": [ "{{base_url}}" ], "path": [ "currencies" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"EUR\",\n \"name\": \"Euro\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies", "host": [ "{{base_url}}" ], "path": [ "currencies" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"EUR\",\n \"name\": \"Euro\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Currency created successfully\",\n \"data\": {\n \"id\": 2,\n \"code\": \"EUR\",\n \"name\": \"Euro\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies", "host": [ "{{base_url}}" ], "path": [ "currencies" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"EUR\",\n \"name\": \"Euro\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}" } ] }, { "name": "Mass Delete Currencies", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/mass-delete", "host": [ "{{base_url}}" ], "path": [ "currencies", "mass-delete" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 2,\n 3\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/mass-delete", "host": [ "{{base_url}}" ], "path": [ "currencies", "mass-delete" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 2,\n 3\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Currencies deleted successfully\",\n \"data\": null\n}" } ] }, { "name": "Show Currency", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/:id", "host": [ "{{base_url}}" ], "path": [ "currencies", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/:id", "host": [ "{{base_url}}" ], "path": [ "currencies", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"symbol\": \"$\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/:id", "host": [ "{{base_url}}" ], "path": [ "currencies", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Currency", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/:id", "host": [ "{{base_url}}" ], "path": [ "currencies", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"USD\",\n \"name\": \"US Dollar\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/:id", "host": [ "{{base_url}}" ], "path": [ "currencies", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"USD\",\n \"name\": \"US Dollar\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Currency updated successfully\",\n \"data\": {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"symbol\": \"$\"\n }\n}" } ] }, { "name": "Delete Currency", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/:id", "host": [ "{{base_url}}" ], "path": [ "currencies", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/currencies/:id", "host": [ "{{base_url}}" ], "path": [ "currencies", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Currency deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Exchange Rates", "description": "Currency exchange rate CRUD.", "item": [ { "name": "List Exchange Rates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates?per_page=15", "host": [ "{{base_url}}" ], "path": [ "exchange-rates" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates?per_page=15", "host": [ "{{base_url}}" ], "path": [ "exchange-rates" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"target_currency\": 2,\n \"rate\": \"3.670000\",\n \"currency\": {\n \"id\": 2,\n \"code\": \"AED\",\n \"name\": \"UAE Dirham\"\n }\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Exchange Rate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates", "host": [ "{{base_url}}" ], "path": [ "exchange-rates" ] }, "description": "`target_currency` is the target currency id; must be unique.", "body": { "mode": "raw", "raw": "{\n \"target_currency\": 2,\n \"rate\": 3.67\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates", "host": [ "{{base_url}}" ], "path": [ "exchange-rates" ] }, "description": "`target_currency` is the target currency id; must be unique.", "body": { "mode": "raw", "raw": "{\n \"target_currency\": 2,\n \"rate\": 3.67\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Exchange rate created successfully\",\n \"data\": {\n \"id\": 1,\n \"target_currency\": 2,\n \"rate\": \"3.670000\",\n \"currency\": {\n \"id\": 2,\n \"code\": \"AED\",\n \"name\": \"UAE Dirham\"\n }\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates", "host": [ "{{base_url}}" ], "path": [ "exchange-rates" ] }, "description": "`target_currency` is the target currency id; must be unique.", "body": { "mode": "raw", "raw": "{\n \"target_currency\": 2,\n \"rate\": 3.67\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The target_currency field is required.\",\n \"errors\": {\n \"target_currency\": [\n \"The target_currency field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Exchange Rate", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates/:id", "host": [ "{{base_url}}" ], "path": [ "exchange-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates/:id", "host": [ "{{base_url}}" ], "path": [ "exchange-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"target_currency\": 2,\n \"rate\": \"3.670000\",\n \"currency\": {\n \"id\": 2,\n \"code\": \"AED\",\n \"name\": \"UAE Dirham\"\n }\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates/:id", "host": [ "{{base_url}}" ], "path": [ "exchange-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Exchange Rate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates/:id", "host": [ "{{base_url}}" ], "path": [ "exchange-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"target_currency\": 2,\n \"rate\": 3.68\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates/:id", "host": [ "{{base_url}}" ], "path": [ "exchange-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"target_currency\": 2,\n \"rate\": 3.68\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Exchange rate updated successfully\",\n \"data\": {\n \"id\": 1,\n \"target_currency\": 2,\n \"rate\": \"3.670000\",\n \"currency\": {\n \"id\": 2,\n \"code\": \"AED\",\n \"name\": \"UAE Dirham\"\n }\n }\n}" } ] }, { "name": "Delete Exchange Rate", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates/:id", "host": [ "{{base_url}}" ], "path": [ "exchange-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/exchange-rates/:id", "host": [ "{{base_url}}" ], "path": [ "exchange-rates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Exchange rate deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Channels", "description": "Super store channels. Read + update only (no create/delete, legacy parity).", "item": [ { "name": "List Channels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/channels", "host": [ "{{base_url}}" ], "path": [ "channels" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/channels", "host": [ "{{base_url}}" ], "path": [ "channels" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"code\": \"default\",\n \"name\": \"Default Channel\",\n \"hostname\": \"https://markatty.com\",\n \"default_locale_id\": 1,\n \"base_currency_id\": 1,\n \"locales\": [\n {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"direction\": \"ltr\"\n }\n ],\n \"currencies\": [\n {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"symbol\": \"$\"\n }\n ]\n }\n ]\n}" } ] }, { "name": "Show Channel", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/channels/:id", "host": [ "{{base_url}}" ], "path": [ "channels", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/channels/:id", "host": [ "{{base_url}}" ], "path": [ "channels", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"code\": \"default\",\n \"name\": \"Default Channel\",\n \"hostname\": \"https://markatty.com\",\n \"default_locale_id\": 1,\n \"base_currency_id\": 1,\n \"locales\": [\n {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"direction\": \"ltr\"\n }\n ],\n \"currencies\": [\n {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"symbol\": \"$\"\n }\n ]\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/channels/:id", "host": [ "{{base_url}}" ], "path": [ "channels", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Channel", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/channels/:id", "host": [ "{{base_url}}" ], "path": [ "channels", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "`locales` and `currencies` are arrays of ids. `default_locale_id` / `base_currency_id` must be included in them.", "body": { "mode": "raw", "raw": "{\n \"code\": \"default\",\n \"name\": \"Default Channel\",\n \"locales\": [\n 1,\n 2\n ],\n \"default_locale_id\": 1,\n \"currencies\": [\n 1,\n 2\n ],\n \"base_currency_id\": 1,\n \"hostname\": \"https://markatty.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/channels/:id", "host": [ "{{base_url}}" ], "path": [ "channels", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "`locales` and `currencies` are arrays of ids. `default_locale_id` / `base_currency_id` must be included in them.", "body": { "mode": "raw", "raw": "{\n \"code\": \"default\",\n \"name\": \"Default Channel\",\n \"locales\": [\n 1,\n 2\n ],\n \"default_locale_id\": 1,\n \"currencies\": [\n 1,\n 2\n ],\n \"base_currency_id\": 1,\n \"hostname\": \"https://markatty.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Channel updated successfully\",\n \"data\": {\n \"id\": 1,\n \"code\": \"default\",\n \"name\": \"Default Channel\",\n \"hostname\": \"https://markatty.com\",\n \"default_locale_id\": 1,\n \"base_currency_id\": 1,\n \"locales\": [\n {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"direction\": \"ltr\"\n }\n ],\n \"currencies\": [\n {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"US Dollar\",\n \"symbol\": \"$\"\n }\n ]\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/channels/:id", "host": [ "{{base_url}}" ], "path": [ "channels", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "`locales` and `currencies` are arrays of ids. `default_locale_id` / `base_currency_id` must be included in them.", "body": { "mode": "raw", "raw": "{\n \"code\": \"default\",\n \"name\": \"Default Channel\",\n \"locales\": [\n 1,\n 2\n ],\n \"default_locale_id\": 1,\n \"currencies\": [\n 1,\n 2\n ],\n \"base_currency_id\": 1,\n \"hostname\": \"https://markatty.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}" } ] } ] }, { "name": "CMS", "description": "CMS pages and templates for the marketing site.", "item": [ { "name": "Pages", "description": "CMS page CRUD. Update uses a locale-prefixed payload (e.g. `en.url_key`).", "item": [ { "name": "List Pages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages?per_page=15", "host": [ "{{base_url}}" ], "path": [ "cms", "pages" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages?per_page=15", "host": [ "{{base_url}}" ], "path": [ "cms", "pages" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"html_content\": \"

About our company...

\",\n \"meta_title\": \"About Us\",\n \"meta_description\": \"\",\n \"meta_keywords\": \"\",\n \"channels\": [\n {\n \"id\": 1,\n \"code\": \"default\",\n \"name\": \"Default Channel\"\n }\n ],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Page", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages", "host": [ "{{base_url}}" ], "path": [ "cms", "pages" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"channels\": [\n 1\n ],\n \"html_content\": \"

About our company...

\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages", "host": [ "{{base_url}}" ], "path": [ "cms", "pages" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"channels\": [\n 1\n ],\n \"html_content\": \"

About our company...

\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Page created successfully\",\n \"data\": {\n \"id\": 1,\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"html_content\": \"

About our company...

\",\n \"meta_title\": \"About Us\",\n \"meta_description\": \"\",\n \"meta_keywords\": \"\",\n \"channels\": [\n {\n \"id\": 1,\n \"code\": \"default\",\n \"name\": \"Default Channel\"\n }\n ],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages", "host": [ "{{base_url}}" ], "path": [ "cms", "pages" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"channels\": [\n 1\n ],\n \"html_content\": \"

About our company...

\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The url_key field is required.\",\n \"errors\": {\n \"url_key\": [\n \"The url_key field is required.\"\n ]\n }\n}" } ] }, { "name": "Mass Delete Pages", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/mass-delete", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", "mass-delete" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 1,\n 2\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/mass-delete", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", "mass-delete" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 1,\n 2\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Pages deleted successfully\",\n \"data\": null\n}" } ] }, { "name": "Show Page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"html_content\": \"

About our company...

\",\n \"meta_title\": \"About Us\",\n \"meta_description\": \"\",\n \"meta_keywords\": \"\",\n \"channels\": [\n {\n \"id\": 1,\n \"code\": \"default\",\n \"name\": \"Default Channel\"\n }\n ],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Page", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Locale-keyed payload — the outer key must match the requested locale (from `x-locale` header / `locale` param, default `en`).", "body": { "mode": "raw", "raw": "{\n \"en\": {\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"html_content\": \"

Updated content...

\"\n },\n \"channels\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Locale-keyed payload — the outer key must match the requested locale (from `x-locale` header / `locale` param, default `en`).", "body": { "mode": "raw", "raw": "{\n \"en\": {\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"html_content\": \"

Updated content...

\"\n },\n \"channels\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Page updated successfully\",\n \"data\": {\n \"id\": 1,\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"html_content\": \"

About our company...

\",\n \"meta_title\": \"About Us\",\n \"meta_description\": \"\",\n \"meta_keywords\": \"\",\n \"channels\": [\n {\n \"id\": 1,\n \"code\": \"default\",\n \"name\": \"Default Channel\"\n }\n ],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Locale-keyed payload — the outer key must match the requested locale (from `x-locale` header / `locale` param, default `en`).", "body": { "mode": "raw", "raw": "{\n \"en\": {\n \"url_key\": \"about-us\",\n \"page_title\": \"About Us\",\n \"html_content\": \"

Updated content...

\"\n },\n \"channels\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The en.url_key field is required.\",\n \"errors\": {\n \"en.url_key\": [\n \"The en.url_key field is required.\"\n ]\n }\n}" } ] }, { "name": "Delete Page", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/pages/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "pages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Page deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Templates", "description": "CMS template CRUD. Update uses a locale-prefixed `content` field.", "item": [ { "name": "List Templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates?per_page=15", "host": [ "{{base_url}}" ], "path": [ "cms", "templates" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates?per_page=15", "host": [ "{{base_url}}" ], "path": [ "cms", "templates" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"template_code\": \"footer_block\",\n \"content\": \"
Template HTML content...
\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates", "host": [ "{{base_url}}" ], "path": [ "cms", "templates" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"template_code\": \"footer_block\",\n \"content\": \"
Template HTML content...
\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates", "host": [ "{{base_url}}" ], "path": [ "cms", "templates" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"template_code\": \"footer_block\",\n \"content\": \"
Template HTML content...
\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Template created successfully\",\n \"data\": {\n \"id\": 1,\n \"template_code\": \"footer_block\",\n \"content\": \"
Template HTML content...
\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates", "host": [ "{{base_url}}" ], "path": [ "cms", "templates" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"template_code\": \"footer_block\",\n \"content\": \"
Template HTML content...
\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The template_code field is required.\",\n \"errors\": {\n \"template_code\": [\n \"The template_code field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Template", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "templates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "templates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"template_code\": \"footer_block\",\n \"content\": \"
Template HTML content...
\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "templates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Template", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "templates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Locale-keyed content — the outer key must match the requested locale.", "body": { "mode": "raw", "raw": "{\n \"template_code\": \"footer_block\",\n \"en\": {\n \"content\": \"
Updated template...
\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "templates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Locale-keyed content — the outer key must match the requested locale.", "body": { "mode": "raw", "raw": "{\n \"template_code\": \"footer_block\",\n \"en\": {\n \"content\": \"
Updated template...
\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Template updated successfully\",\n \"data\": {\n \"id\": 1,\n \"template_code\": \"footer_block\",\n \"content\": \"
Template HTML content...
\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Template", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "templates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/cms/templates/:id", "host": [ "{{base_url}}" ], "path": [ "cms", "templates", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Template deleted successfully\",\n \"data\": null\n}" } ] } ] } ] }, { "name": "Configuration", "description": "System configuration tree and payment gateway settings.", "item": [ { "name": "Configuration Tree", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration", "host": [ "{{base_url}}" ], "path": [ "configuration" ] }, "description": "Full configuration tree (sections/groups/fields)." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration", "host": [ "{{base_url}}" ], "path": [ "configuration" ] }, "description": "Full configuration tree (sections/groups/fields)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Configuration tree\",\n \"data\": [\n {\n \"key\": \"general\",\n \"name\": \"General\",\n \"children\": [\n {\n \"key\": \"general.settings\",\n \"name\": \"Settings\"\n }\n ]\n }\n ]\n}" } ] }, { "name": "Get Payment Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/payment-settings", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-settings" ] }, "description": "Payment gateway settings grouped by gateway." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/payment-settings", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-settings" ] }, "description": "Payment gateway settings grouped by gateway." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Payment gateway settings\",\n \"data\": {\n \"stripe\": {\n \"active\": true,\n \"api_key\": \"pk_live_***\",\n \"secret_key\": \"sk_live_***\"\n },\n \"paypal\": {\n \"active\": false,\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n }\n}" } ] }, { "name": "Update Payment Gateway", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/payment-settings/:gateway", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-settings", ":gateway" ], "variable": [ { "key": "gateway", "value": "stripe", "description": "The gateway" } ] }, "description": "Update credentials/settings for one gateway. Path param must be one of the allowed gateways.", "body": { "mode": "raw", "raw": "{\n \"api_key\": \"pk_live_xxx\",\n \"secret_key\": \"sk_live_xxx\",\n \"webhook_secret\": \"whsec_xxx\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/payment-settings/:gateway", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-settings", ":gateway" ], "variable": [ { "key": "gateway", "value": "stripe", "description": "The gateway" } ] }, "description": "Update credentials/settings for one gateway. Path param must be one of the allowed gateways.", "body": { "mode": "raw", "raw": "{\n \"api_key\": \"pk_live_xxx\",\n \"secret_key\": \"sk_live_xxx\",\n \"webhook_secret\": \"whsec_xxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Stripe settings updated successfully\",\n \"data\": null\n}" }, { "name": "Invalid Gateway", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/payment-settings/:gateway", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-settings", ":gateway" ], "variable": [ { "key": "gateway", "value": "stripe", "description": "The gateway" } ] }, "description": "Update credentials/settings for one gateway. Path param must be one of the allowed gateways.", "body": { "mode": "raw", "raw": "{\n \"api_key\": \"pk_live_xxx\",\n \"secret_key\": \"sk_live_xxx\",\n \"webhook_secret\": \"whsec_xxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Invalid payment gateway: foo\",\n \"data\": null\n}" } ] }, { "name": "Toggle Payment Gateway", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/payment-settings/:gateway/toggle", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-settings", ":gateway", "toggle" ], "variable": [ { "key": "gateway", "value": "stripe", "description": "The gateway" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/payment-settings/:gateway/toggle", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-settings", ":gateway", "toggle" ], "variable": [ { "key": "gateway", "value": "stripe", "description": "The gateway" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Stripe has been activated\",\n \"data\": {\n \"active\": true\n }\n}" }, { "name": "Invalid Gateway", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/payment-settings/:gateway/toggle", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-settings", ":gateway", "toggle" ], "variable": [ { "key": "gateway", "value": "stripe", "description": "The gateway" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Invalid payment gateway: foo\",\n \"data\": null\n}" } ] }, { "name": "Show Configuration Section", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/:slug/:slug2", "host": [ "{{base_url}}" ], "path": [ "configuration", ":slug", ":slug2" ], "variable": [ { "key": "slug", "value": "general", "description": "The slug" }, { "key": "slug2", "value": "settings", "description": "The slug2" } ] }, "description": "Values for one configuration section (`/{slug}/{slug2}`)." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/:slug/:slug2", "host": [ "{{base_url}}" ], "path": [ "configuration", ":slug", ":slug2" ], "variable": [ { "key": "slug", "value": "general", "description": "The slug" }, { "key": "slug2", "value": "settings", "description": "The slug2" } ] }, "description": "Values for one configuration section (`/{slug}/{slug2}`)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Configuration values\",\n \"data\": {\n \"general.settings.site_name\": \"Markatty\",\n \"general.settings.support_email\": \"support@markatty.com\"\n }\n}" } ] }, { "name": "Save Configuration Section", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/:slug/:slug2", "host": [ "{{base_url}}" ], "path": [ "configuration", ":slug", ":slug2" ], "variable": [ { "key": "slug", "value": "general", "description": "The slug" }, { "key": "slug2", "value": "settings", "description": "The slug2" } ] }, "description": "Save key/value configuration for a section. Body is a free-form map of config keys to values.", "body": { "mode": "raw", "raw": "{\n \"general.settings.site_name\": \"Markatty\",\n \"general.settings.support_email\": \"support@markatty.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/configuration/:slug/:slug2", "host": [ "{{base_url}}" ], "path": [ "configuration", ":slug", ":slug2" ], "variable": [ { "key": "slug", "value": "general", "description": "The slug" }, { "key": "slug2", "value": "settings", "description": "The slug2" } ] }, "description": "Save key/value configuration for a section. Body is a free-form map of config keys to values.", "body": { "mode": "raw", "raw": "{\n \"general.settings.site_name\": \"Markatty\",\n \"general.settings.support_email\": \"support@markatty.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Configuration saved successfully.\",\n \"data\": null\n}" } ] } ] }, { "name": "Subscription Plans", "description": "SaaS subscription plan CRUD + feature matrix.", "item": [ { "name": "List Plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans?per_page=15", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans?per_page=15", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\",\n \"monthly_amount\": \"29.9900\",\n \"yearly_amount\": \"299.9900\",\n \"status\": 1,\n \"features\": [],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Plan", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"pro\",\n \"name\": \"Professional\",\n \"monthly_amount\": 29.99,\n \"yearly_amount\": 299.99\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"pro\",\n \"name\": \"Professional\",\n \"monthly_amount\": 29.99,\n \"yearly_amount\": 299.99\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Plan created successfully\",\n \"data\": {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\",\n \"monthly_amount\": \"29.9900\",\n \"yearly_amount\": \"299.9900\",\n \"status\": 1,\n \"features\": [],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"code\": \"pro\",\n \"name\": \"Professional\",\n \"monthly_amount\": 29.99,\n \"yearly_amount\": 299.99\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The code field is required.\",\n \"errors\": {\n \"code\": [\n \"The code field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Plan", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\",\n \"monthly_amount\": \"29.9900\",\n \"yearly_amount\": \"299.9900\",\n \"status\": 1,\n \"features\": [\n {\n \"feature_id\": 1,\n \"name\": \"Products Limit\",\n \"value\": \"500\",\n \"is_shown\": true\n }\n ],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Plan", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Professional\",\n \"monthly_amount\": 34.99,\n \"yearly_amount\": 349.99\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Professional\",\n \"monthly_amount\": 34.99,\n \"yearly_amount\": 349.99\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Plan updated successfully\",\n \"data\": {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\",\n \"monthly_amount\": \"29.9900\",\n \"yearly_amount\": \"299.9900\",\n \"status\": 1,\n \"features\": [],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Plan", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Plan deleted successfully\",\n \"data\": null\n}" } ] }, { "name": "Toggle Plan Status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id/toggle-status", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id", "toggle-status" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id/toggle-status", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id", "toggle-status" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Plan status updated\",\n \"data\": {\n \"status\": 0\n }\n}" } ] }, { "name": "Update Plan Features", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id/features", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id", "features" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Replace the feature matrix of a plan.", "body": { "mode": "raw", "raw": "{\n \"features\": [\n {\n \"feature_id\": 1,\n \"value\": \"500\",\n \"is_shown\": true\n },\n {\n \"feature_id\": 2,\n \"value\": \"1\",\n \"is_shown\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id/features", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id", "features" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Replace the feature matrix of a plan.", "body": { "mode": "raw", "raw": "{\n \"features\": [\n {\n \"feature_id\": 1,\n \"value\": \"500\",\n \"is_shown\": true\n },\n {\n \"feature_id\": 2,\n \"value\": \"1\",\n \"is_shown\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Plan features updated successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/plans/:id/features", "host": [ "{{base_url}}" ], "path": [ "subscription", "plans", ":id", "features" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "Replace the feature matrix of a plan.", "body": { "mode": "raw", "raw": "{\n \"features\": [\n {\n \"feature_id\": 1,\n \"value\": \"500\",\n \"is_shown\": true\n },\n {\n \"feature_id\": 2,\n \"value\": \"1\",\n \"is_shown\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The features field is required.\",\n \"errors\": {\n \"features\": [\n \"The features field is required.\"\n ]\n }\n}" } ] } ] }, { "name": "Subscription Features", "description": "Plan feature definitions grouped in sections.", "item": [ { "name": "List Features", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features?per_page=15&active_only=true", "host": [ "{{base_url}}" ], "path": [ "subscription", "features" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "active_only", "value": "true", "description": "Only active features", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features?per_page=15&active_only=true", "host": [ "{{base_url}}" ], "path": [ "subscription", "features" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "active_only", "value": "true", "description": "Only active features", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"section\": {\n \"id\": 1,\n \"name\": \"Catalog\"\n },\n \"is_bool\": 0,\n \"active\": 1,\n \"position\": 1,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Create Feature", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features", "host": [ "{{base_url}}" ], "path": [ "subscription", "features" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"is_bool\": false,\n \"active\": true,\n \"position\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features", "host": [ "{{base_url}}" ], "path": [ "subscription", "features" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"is_bool\": false,\n \"active\": true,\n \"position\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Feature created successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"section\": {\n \"id\": 1,\n \"name\": \"Catalog\"\n },\n \"is_bool\": 0,\n \"active\": 1,\n \"position\": 1,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features", "host": [ "{{base_url}}" ], "path": [ "subscription", "features" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"is_bool\": false,\n \"active\": true,\n \"position\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}" } ] }, { "name": "List Sections", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/sections", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", "sections" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/sections", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", "sections" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Catalog\"\n },\n {\n \"id\": 2,\n \"name\": \"Marketing\"\n }\n ]\n}" } ] }, { "name": "Show Feature", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"section\": {\n \"id\": 1,\n \"name\": \"Catalog\"\n },\n \"is_bool\": 0,\n \"active\": 1,\n \"position\": 1,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Feature", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"is_bool\": false,\n \"active\": true,\n \"position\": 2\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"is_bool\": false,\n \"active\": true,\n \"position\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Feature updated successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Products Limit\",\n \"section_id\": 1,\n \"section\": {\n \"id\": 1,\n \"name\": \"Catalog\"\n },\n \"is_bool\": 0,\n \"active\": 1,\n \"position\": 1,\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Feature", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Feature deleted successfully\",\n \"data\": null\n}" } ] }, { "name": "Toggle Feature Active", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id/toggle-active", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id", "toggle-active" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/features/:id/toggle-active", "host": [ "{{base_url}}" ], "path": [ "subscription", "features", ":id", "toggle-active" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Feature status updated\",\n \"data\": {\n \"active\": 0\n }\n}" } ] } ] }, { "name": "Subscription Invoices", "description": "Read-only subscription invoices.", "item": [ { "name": "List Invoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices?per_page=15&status=paid&company_id=1", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "status", "value": "paid", "description": "Filter by status", "disabled": true }, { "key": "company_id", "value": "1", "description": "Filter by company id", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices?per_page=15&status=paid&company_id=1", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "status", "value": "paid", "description": "Filter by status", "disabled": true }, { "key": "company_id", "value": "1", "description": "Filter by company id", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"increment_id\": \"INV-2026-0001\",\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"plan_name\": \"Professional\",\n \"amount\": \"29.9900\",\n \"status\": \"paid\",\n \"period_start\": \"2026-01-01\",\n \"period_end\": \"2026-01-31\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Invoice Statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices/statistics?days=30", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices", "statistics" ], "query": [ { "key": "days", "value": "30", "description": "Window in days (default 30)", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices/statistics?days=30", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices", "statistics" ], "query": [ { "key": "days", "value": "30", "description": "Window in days (default 30)", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"total_invoices\": 320,\n \"total_amount\": \"9600.00\",\n \"paid\": 290,\n \"pending\": 30\n }\n}" } ] }, { "name": "Invoices By Company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices/company/:companyId?per_page=15", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices", "company", ":companyId" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ], "variable": [ { "key": "companyId", "value": "1", "description": "The companyId" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices/company/:companyId?per_page=15", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices", "company", ":companyId" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ], "variable": [ { "key": "companyId", "value": "1", "description": "The companyId" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"increment_id\": \"INV-2026-0001\",\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"plan_name\": \"Professional\",\n \"amount\": \"29.9900\",\n \"status\": \"paid\",\n \"period_start\": \"2026-01-01\",\n \"period_end\": \"2026-01-31\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Show Invoice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"increment_id\": \"INV-2026-0001\",\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"plan_name\": \"Professional\",\n \"amount\": \"29.9900\",\n \"status\": \"paid\",\n \"period_start\": \"2026-01-01\",\n \"period_end\": \"2026-01-31\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/invoices/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "invoices", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] } ] }, { "name": "Recurring Profiles", "description": "Purchased subscription plans (recurring profiles).", "item": [ { "name": "List Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles?per_page=15&state=active&company_id=1", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "state", "value": "active", "description": "Filter by state (e.g. active, canceled, expired)", "disabled": true }, { "key": "company_id", "value": "1", "description": "Filter by company id", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles?per_page=15&state=active&company_id=1", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "state", "value": "active", "description": "Filter by state (e.g. active, canceled, expired)", "disabled": true }, { "key": "company_id", "value": "1", "description": "Filter by company id", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"plan_id\": 1,\n \"plan\": {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\"\n },\n \"state\": \"active\",\n \"period_unit\": \"month\",\n \"duration\": 1,\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-02-01\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Profile Statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/statistics", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", "statistics" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/statistics", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", "statistics" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"total\": 120,\n \"active\": 85,\n \"canceled\": 20,\n \"expired\": 15\n }\n}" } ] }, { "name": "Show Profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"plan_id\": 1,\n \"plan\": {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\"\n },\n \"state\": \"active\",\n \"period_unit\": \"month\",\n \"duration\": 1,\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-02-01\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/:id", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Assign Plan To Company", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/assign/:companyId", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", "assign", ":companyId" ], "variable": [ { "key": "companyId", "value": "1", "description": "The companyId" } ] }, "description": "Manually assign a plan to a company.", "body": { "mode": "raw", "raw": "{\n \"plan_id\": 1,\n \"period_unit\": \"month\",\n \"duration\": 1,\n \"start_date\": \"2026-07-20\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/assign/:companyId", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", "assign", ":companyId" ], "variable": [ { "key": "companyId", "value": "1", "description": "The companyId" } ] }, "description": "Manually assign a plan to a company.", "body": { "mode": "raw", "raw": "{\n \"plan_id\": 1,\n \"period_unit\": \"month\",\n \"duration\": 1,\n \"start_date\": \"2026-07-20\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Plan assigned successfully\",\n \"data\": {\n \"id\": 1,\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"plan_id\": 1,\n \"plan\": {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\"\n },\n \"state\": \"active\",\n \"period_unit\": \"month\",\n \"duration\": 1,\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-02-01\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/assign/:companyId", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", "assign", ":companyId" ], "variable": [ { "key": "companyId", "value": "1", "description": "The companyId" } ] }, "description": "Manually assign a plan to a company.", "body": { "mode": "raw", "raw": "{\n \"plan_id\": 1,\n \"period_unit\": \"month\",\n \"duration\": 1,\n \"start_date\": \"2026-07-20\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The plan_id field is required.\",\n \"errors\": {\n \"plan_id\": [\n \"The plan_id field is required.\"\n ]\n }\n}" } ] }, { "name": "Cancel Profile", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Profile canceled\",\n \"data\": {\n \"id\": 1,\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"plan_id\": 1,\n \"plan\": {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\"\n },\n \"state\": \"canceled\",\n \"period_unit\": \"month\",\n \"duration\": 1,\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-02-01\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Reactivate Profile", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/:id/reactivate", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", ":id", "reactivate" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/subscription/profiles/:id/reactivate", "host": [ "{{base_url}}" ], "path": [ "subscription", "profiles", ":id", "reactivate" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Profile reactivated\",\n \"data\": {\n \"id\": 1,\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"plan_id\": 1,\n \"plan\": {\n \"id\": 1,\n \"code\": \"pro\",\n \"name\": \"Professional\"\n },\n \"state\": \"active\",\n \"period_unit\": \"month\",\n \"duration\": 1,\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-02-01\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] } ] }, { "name": "Content", "description": "Marketing site content: videos/media, sliders, partner logos, clients, testimonials. All create/update endpoints use multipart/form-data because of file uploads. Updates are POST /{id} (not PUT) so files can be sent.", "item": [ { "name": "Videos (Media)", "description": "Media items (image or video).", "item": [ { "name": "List Media", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos", "host": [ "{{base_url}}" ], "path": [ "content", "videos" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos", "host": [ "{{base_url}}" ], "path": [ "content", "videos" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=abc123\",\n \"image_path\": \"storage/content/videos/thumb-1.jpg\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ]\n}" } ] }, { "name": "Create Media", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos", "host": [ "{{base_url}}" ], "path": [ "content", "videos" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "video", "type": "text", "description": "required — image|video" }, { "key": "url", "value": "https://www.youtube.com/watch?v=abc123", "type": "text", "description": "required — url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — file, max 50 MB" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos", "host": [ "{{base_url}}" ], "path": [ "content", "videos" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "video", "type": "text", "description": "required — image|video" }, { "key": "url", "value": "https://www.youtube.com/watch?v=abc123", "type": "text", "description": "required — url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — file, max 50 MB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Media created successfully\",\n \"data\": {\n \"id\": 1,\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=abc123\",\n \"image_path\": \"storage/content/videos/thumb-1.jpg\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos", "host": [ "{{base_url}}" ], "path": [ "content", "videos" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "video", "type": "text", "description": "required — image|video" }, { "key": "url", "value": "https://www.youtube.com/watch?v=abc123", "type": "text", "description": "required — url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — file, max 50 MB" } ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The type field is required.\",\n \"errors\": {\n \"type\": [\n \"The type field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Media", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos/:id", "host": [ "{{base_url}}" ], "path": [ "content", "videos", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos/:id", "host": [ "{{base_url}}" ], "path": [ "content", "videos", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=abc123\",\n \"image_path\": \"storage/content/videos/thumb-1.jpg\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos/:id", "host": [ "{{base_url}}" ], "path": [ "content", "videos", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Media", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos/:id", "host": [ "{{base_url}}" ], "path": [ "content", "videos", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "video", "type": "text", "description": "image|video" }, { "key": "url", "value": "https://www.youtube.com/watch?v=abc123", "type": "text", "description": "url" }, { "key": "image_path", "type": "file", "src": [], "description": "optional — file, max 50 MB" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos/:id", "host": [ "{{base_url}}" ], "path": [ "content", "videos", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "video", "type": "text", "description": "image|video" }, { "key": "url", "value": "https://www.youtube.com/watch?v=abc123", "type": "text", "description": "url" }, { "key": "image_path", "type": "file", "src": [], "description": "optional — file, max 50 MB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Media updated successfully\",\n \"data\": {\n \"id\": 1,\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=abc123\",\n \"image_path\": \"storage/content/videos/thumb-1.jpg\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Media", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos/:id", "host": [ "{{base_url}}" ], "path": [ "content", "videos", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/videos/:id", "host": [ "{{base_url}}" ], "path": [ "content", "videos", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Media deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Sliders", "description": "Homepage slider images.", "item": [ { "name": "List Sliders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders", "host": [ "{{base_url}}" ], "path": [ "content", "sliders" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders", "host": [ "{{base_url}}" ], "path": [ "content", "sliders" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"url\": \"https://markatty.com/promo\",\n \"image_path\": \"storage/content/sliders/slide-1.jpg\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ]\n}" } ] }, { "name": "Create Slider", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders", "host": [ "{{base_url}}" ], "path": [ "content", "sliders" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://markatty.com/promo", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders", "host": [ "{{base_url}}" ], "path": [ "content", "sliders" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://markatty.com/promo", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Slider created successfully\",\n \"data\": {\n \"id\": 1,\n \"url\": \"https://markatty.com/promo\",\n \"image_path\": \"storage/content/sliders/slide-1.jpg\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders", "host": [ "{{base_url}}" ], "path": [ "content", "sliders" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://markatty.com/promo", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The image_path field is required.\",\n \"errors\": {\n \"image_path\": [\n \"The image_path field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Slider", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders/:id", "host": [ "{{base_url}}" ], "path": [ "content", "sliders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders/:id", "host": [ "{{base_url}}" ], "path": [ "content", "sliders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"url\": \"https://markatty.com/promo\",\n \"image_path\": \"storage/content/sliders/slide-1.jpg\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders/:id", "host": [ "{{base_url}}" ], "path": [ "content", "sliders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Slider", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders/:id", "host": [ "{{base_url}}" ], "path": [ "content", "sliders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://markatty.com/promo", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders/:id", "host": [ "{{base_url}}" ], "path": [ "content", "sliders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://markatty.com/promo", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Slider updated successfully\",\n \"data\": {\n \"id\": 1,\n \"url\": \"https://markatty.com/promo\",\n \"image_path\": \"storage/content/sliders/slide-1.jpg\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Slider", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders/:id", "host": [ "{{base_url}}" ], "path": [ "content", "sliders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/sliders/:id", "host": [ "{{base_url}}" ], "path": [ "content", "sliders", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Slider deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Partners (Logos)", "description": "Partner logos.", "item": [ { "name": "List Logos", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners", "host": [ "{{base_url}}" ], "path": [ "content", "partners" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners", "host": [ "{{base_url}}" ], "path": [ "content", "partners" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"url\": \"https://partner.example.com\",\n \"image_path\": \"storage/content/partners/logo-1.png\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ]\n}" } ] }, { "name": "Create Logo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners", "host": [ "{{base_url}}" ], "path": [ "content", "partners" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://partner.example.com", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners", "host": [ "{{base_url}}" ], "path": [ "content", "partners" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://partner.example.com", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Logo created successfully\",\n \"data\": {\n \"id\": 1,\n \"url\": \"https://partner.example.com\",\n \"image_path\": \"storage/content/partners/logo-1.png\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners", "host": [ "{{base_url}}" ], "path": [ "content", "partners" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://partner.example.com", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "required — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The image_path field is required.\",\n \"errors\": {\n \"image_path\": [\n \"The image_path field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Logo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners/:id", "host": [ "{{base_url}}" ], "path": [ "content", "partners", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners/:id", "host": [ "{{base_url}}" ], "path": [ "content", "partners", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"url\": \"https://partner.example.com\",\n \"image_path\": \"storage/content/partners/logo-1.png\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners/:id", "host": [ "{{base_url}}" ], "path": [ "content", "partners", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Logo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners/:id", "host": [ "{{base_url}}" ], "path": [ "content", "partners", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://partner.example.com", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners/:id", "host": [ "{{base_url}}" ], "path": [ "content", "partners", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://partner.example.com", "type": "text", "description": "optional — link url" }, { "key": "image_path", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg max 5 MB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Logo updated successfully\",\n \"data\": {\n \"id\": 1,\n \"url\": \"https://partner.example.com\",\n \"image_path\": \"storage/content/partners/logo-1.png\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Logo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners/:id", "host": [ "{{base_url}}" ], "path": [ "content", "partners", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/partners/:id", "host": [ "{{base_url}}" ], "path": [ "content", "partners", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Logo deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Clients", "description": "Client entries with logo.", "item": [ { "name": "List Clients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients", "host": [ "{{base_url}}" ], "path": [ "content", "clients" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients", "host": [ "{{base_url}}" ], "path": [ "content", "clients" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Client Co\",\n \"logo\": \"storage/content/clients/logo-1.png\",\n \"link\": \"https://client.example.com\",\n \"category\": \"retail\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ]\n}" } ] }, { "name": "Create Client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients", "host": [ "{{base_url}}" ], "path": [ "content", "clients" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Client Co", "type": "text", "description": "required — string max 255" }, { "key": "logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,webp,svg max 2 MB" }, { "key": "link", "value": "https://client.example.com", "type": "text", "description": "optional" }, { "key": "category", "value": "retail", "type": "text", "description": "optional" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients", "host": [ "{{base_url}}" ], "path": [ "content", "clients" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Client Co", "type": "text", "description": "required — string max 255" }, { "key": "logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,webp,svg max 2 MB" }, { "key": "link", "value": "https://client.example.com", "type": "text", "description": "optional" }, { "key": "category", "value": "retail", "type": "text", "description": "optional" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Client created successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Client Co\",\n \"logo\": \"storage/content/clients/logo-1.png\",\n \"link\": \"https://client.example.com\",\n \"category\": \"retail\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients", "host": [ "{{base_url}}" ], "path": [ "content", "clients" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Client Co", "type": "text", "description": "required — string max 255" }, { "key": "logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,webp,svg max 2 MB" }, { "key": "link", "value": "https://client.example.com", "type": "text", "description": "optional" }, { "key": "category", "value": "retail", "type": "text", "description": "optional" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The name field is required.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Client", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients/:id", "host": [ "{{base_url}}" ], "path": [ "content", "clients", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients/:id", "host": [ "{{base_url}}" ], "path": [ "content", "clients", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Client Co\",\n \"logo\": \"storage/content/clients/logo-1.png\",\n \"link\": \"https://client.example.com\",\n \"category\": \"retail\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients/:id", "host": [ "{{base_url}}" ], "path": [ "content", "clients", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients/:id", "host": [ "{{base_url}}" ], "path": [ "content", "clients", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Client Co", "type": "text", "description": "optional — string max 255" }, { "key": "logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,webp,svg max 2 MB" }, { "key": "link", "value": "https://client.example.com", "type": "text", "description": "optional" }, { "key": "category", "value": "retail", "type": "text", "description": "optional" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients/:id", "host": [ "{{base_url}}" ], "path": [ "content", "clients", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Client Co", "type": "text", "description": "optional — string max 255" }, { "key": "logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,webp,svg max 2 MB" }, { "key": "link", "value": "https://client.example.com", "type": "text", "description": "optional" }, { "key": "category", "value": "retail", "type": "text", "description": "optional" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Client updated successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Client Co\",\n \"logo\": \"storage/content/clients/logo-1.png\",\n \"link\": \"https://client.example.com\",\n \"category\": \"retail\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Client", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients/:id", "host": [ "{{base_url}}" ], "path": [ "content", "clients", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/clients/:id", "host": [ "{{base_url}}" ], "path": [ "content", "clients", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Client deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Testimonials", "description": "Customer testimonials.", "item": [ { "name": "List Testimonials", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"author_name\": \"Jane Doe\",\n \"company_name\": \"Client Co\",\n \"rating\": 5,\n \"comment\": \"Great platform!\",\n \"company_logo\": \"storage/content/testimonials/logo-1.png\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ]\n}" } ] }, { "name": "Create Testimonial", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "author_name", "value": "Jane Doe", "type": "text", "description": "required" }, { "key": "company_name", "value": "Client Co", "type": "text", "description": "optional" }, { "key": "rating", "value": "5", "type": "text", "description": "required — integer 1-5" }, { "key": "comment", "value": "Great platform!", "type": "text", "description": "required" }, { "key": "company_logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,webp max 2 MB" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "author_name", "value": "Jane Doe", "type": "text", "description": "required" }, { "key": "company_name", "value": "Client Co", "type": "text", "description": "optional" }, { "key": "rating", "value": "5", "type": "text", "description": "required — integer 1-5" }, { "key": "comment", "value": "Great platform!", "type": "text", "description": "required" }, { "key": "company_logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,webp max 2 MB" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Testimonial created successfully\",\n \"data\": {\n \"id\": 1,\n \"author_name\": \"Jane Doe\",\n \"company_name\": \"Client Co\",\n \"rating\": 5,\n \"comment\": \"Great platform!\",\n \"company_logo\": \"storage/content/testimonials/logo-1.png\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "author_name", "value": "Jane Doe", "type": "text", "description": "required" }, { "key": "company_name", "value": "Client Co", "type": "text", "description": "optional" }, { "key": "rating", "value": "5", "type": "text", "description": "required — integer 1-5" }, { "key": "comment", "value": "Great platform!", "type": "text", "description": "required" }, { "key": "company_logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,webp max 2 MB" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The author_name field is required.\",\n \"errors\": {\n \"author_name\": [\n \"The author_name field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Testimonial", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials/:id", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials/:id", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"author_name\": \"Jane Doe\",\n \"company_name\": \"Client Co\",\n \"rating\": 5,\n \"comment\": \"Great platform!\",\n \"company_logo\": \"storage/content/testimonials/logo-1.png\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials/:id", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Testimonial", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials/:id", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "author_name", "value": "Jane Doe", "type": "text", "description": "optional" }, { "key": "company_name", "value": "Client Co", "type": "text", "description": "optional" }, { "key": "rating", "value": "5", "type": "text", "description": "optional — integer 1-5" }, { "key": "comment", "value": "Great platform!", "type": "text", "description": "optional" }, { "key": "company_logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg max 2 MB" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials/:id", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "author_name", "value": "Jane Doe", "type": "text", "description": "optional" }, { "key": "company_name", "value": "Client Co", "type": "text", "description": "optional" }, { "key": "rating", "value": "5", "type": "text", "description": "optional — integer 1-5" }, { "key": "comment", "value": "Great platform!", "type": "text", "description": "optional" }, { "key": "company_logo", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg max 2 MB" }, { "key": "locale", "value": "en", "type": "text", "description": "optional" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Testimonial updated successfully\",\n \"data\": {\n \"id\": 1,\n \"author_name\": \"Jane Doe\",\n \"company_name\": \"Client Co\",\n \"rating\": 5,\n \"comment\": \"Great platform!\",\n \"company_logo\": \"storage/content/testimonials/logo-1.png\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Testimonial", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials/:id", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/content/testimonials/:id", "host": [ "{{base_url}}" ], "path": [ "content", "testimonials", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Testimonial deleted successfully\",\n \"data\": null\n}" } ] } ] } ] }, { "name": "Themes", "description": "Storefront theme catalog (config file based, keyed by `key`). Create/update accept multipart because of `main_image`.", "item": [ { "name": "List Themes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes", "host": [ "{{base_url}}" ], "path": [ "themes" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes", "host": [ "{{base_url}}" ], "path": [ "themes" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"key\": \"modern\",\n \"name\": \"Modern\",\n \"industry\": \"fashion\",\n \"active\": true,\n \"main\": false,\n \"preview\": \"themes/modern/preview.png\",\n \"main_theme\": \"default\",\n \"pagination\": 12,\n \"main_image\": \"storage/themes/modern/main.png\"\n }\n ]\n}" } ] }, { "name": "Theme Statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/statistics", "host": [ "{{base_url}}" ], "path": [ "themes", "statistics" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/statistics", "host": [ "{{base_url}}" ], "path": [ "themes", "statistics" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"total\": 12,\n \"active\": 9,\n \"usage\": [\n {\n \"key\": \"modern\",\n \"companies\": 34\n }\n ]\n }\n}" } ] }, { "name": "Create Theme", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes", "host": [ "{{base_url}}" ], "path": [ "themes" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "key", "value": "modern", "type": "text", "description": "required — unique theme key" }, { "key": "preview", "value": "themes/modern/preview.png", "type": "text", "description": "required — preview path/url" }, { "key": "main_theme", "value": "default", "type": "text", "description": "optional — parent theme" }, { "key": "main_image", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg,webp max 5 MB" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes", "host": [ "{{base_url}}" ], "path": [ "themes" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "key", "value": "modern", "type": "text", "description": "required — unique theme key" }, { "key": "preview", "value": "themes/modern/preview.png", "type": "text", "description": "required — preview path/url" }, { "key": "main_theme", "value": "default", "type": "text", "description": "optional — parent theme" }, { "key": "main_image", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg,webp max 5 MB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Theme created successfully\",\n \"data\": {\n \"key\": \"modern\",\n \"name\": \"Modern\",\n \"industry\": \"fashion\",\n \"active\": true,\n \"main\": false,\n \"preview\": \"themes/modern/preview.png\",\n \"main_theme\": \"default\",\n \"pagination\": 12,\n \"main_image\": \"storage/themes/modern/main.png\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes", "host": [ "{{base_url}}" ], "path": [ "themes" ] }, "description": "", "body": { "mode": "formdata", "formdata": [ { "key": "key", "value": "modern", "type": "text", "description": "required — unique theme key" }, { "key": "preview", "value": "themes/modern/preview.png", "type": "text", "description": "required — preview path/url" }, { "key": "main_theme", "value": "default", "type": "text", "description": "optional — parent theme" }, { "key": "main_image", "type": "file", "src": [], "description": "optional — jpg,jpeg,png,gif,svg,webp max 5 MB" } ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The key field is required.\",\n \"errors\": {\n \"key\": [\n \"The key field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Theme", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/:key", "host": [ "{{base_url}}" ], "path": [ "themes", ":key" ], "variable": [ { "key": "key", "value": "modern", "description": "The key" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/:key", "host": [ "{{base_url}}" ], "path": [ "themes", ":key" ], "variable": [ { "key": "key", "value": "modern", "description": "The key" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"key\": \"modern\",\n \"name\": \"Modern\",\n \"industry\": \"fashion\",\n \"active\": true,\n \"main\": false,\n \"preview\": \"themes/modern/preview.png\",\n \"main_theme\": \"default\",\n \"pagination\": 12,\n \"main_image\": \"storage/themes/modern/main.png\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/:key", "host": [ "{{base_url}}" ], "path": [ "themes", ":key" ], "variable": [ { "key": "key", "value": "modern", "description": "The key" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Theme", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/:key", "host": [ "{{base_url}}" ], "path": [ "themes", ":key" ], "variable": [ { "key": "key", "value": "modern", "description": "The key" } ] }, "description": "All fields optional. Use JSON here; if you need to replace `main_image`, switch the body to form-data and use POST with `_method=PUT` if the server rejects multipart PUT.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Modern\",\n \"industry\": \"fashion\",\n \"active\": true,\n \"preview\": \"themes/modern/preview.png\",\n \"main_theme\": \"default\",\n \"pagination\": 12,\n \"main\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/:key", "host": [ "{{base_url}}" ], "path": [ "themes", ":key" ], "variable": [ { "key": "key", "value": "modern", "description": "The key" } ] }, "description": "All fields optional. Use JSON here; if you need to replace `main_image`, switch the body to form-data and use POST with `_method=PUT` if the server rejects multipart PUT.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Modern\",\n \"industry\": \"fashion\",\n \"active\": true,\n \"preview\": \"themes/modern/preview.png\",\n \"main_theme\": \"default\",\n \"pagination\": 12,\n \"main\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Theme updated successfully\",\n \"data\": {\n \"key\": \"modern\",\n \"name\": \"Modern\",\n \"industry\": \"fashion\",\n \"active\": true,\n \"main\": false,\n \"preview\": \"themes/modern/preview.png\",\n \"main_theme\": \"default\",\n \"pagination\": 12,\n \"main_image\": \"storage/themes/modern/main.png\"\n }\n}" } ] }, { "name": "Delete Theme", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/:key", "host": [ "{{base_url}}" ], "path": [ "themes", ":key" ], "variable": [ { "key": "key", "value": "modern", "description": "The key" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/themes/:key", "host": [ "{{base_url}}" ], "path": [ "themes", ":key" ], "variable": [ { "key": "key", "value": "modern", "description": "The key" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Theme deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Page Contents", "description": "Key/value/locale content strings for marketing pages.", "item": [ { "name": "List Page Contents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents", "host": [ "{{base_url}}" ], "path": [ "page-contents" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents", "host": [ "{{base_url}}" ], "path": [ "page-contents" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"key\": \"home.hero.title\",\n \"value\": \"Build your store in minutes\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ]\n}" } ] }, { "name": "Content Tree By Locale", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/tree/:locale", "host": [ "{{base_url}}" ], "path": [ "page-contents", "tree", ":locale" ], "variable": [ { "key": "locale", "value": "en", "description": "The locale" } ] }, "description": "Nested key tree for one locale." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/tree/:locale", "host": [ "{{base_url}}" ], "path": [ "page-contents", "tree", ":locale" ], "variable": [ { "key": "locale", "value": "en", "description": "The locale" } ] }, "description": "Nested key tree for one locale." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"home\": {\n \"hero\": {\n \"title\": \"Build your store in minutes\",\n \"subtitle\": \"No code needed\"\n }\n }\n }\n}" } ] }, { "name": "Create Page Content", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents", "host": [ "{{base_url}}" ], "path": [ "page-contents" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"key\": \"home.hero.title\",\n \"value\": \"Build your store in minutes\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents", "host": [ "{{base_url}}" ], "path": [ "page-contents" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"key\": \"home.hero.title\",\n \"value\": \"Build your store in minutes\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Content created successfully\",\n \"data\": {\n \"id\": 1,\n \"key\": \"home.hero.title\",\n \"value\": \"Build your store in minutes\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents", "host": [ "{{base_url}}" ], "path": [ "page-contents" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"key\": \"home.hero.title\",\n \"value\": \"Build your store in minutes\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The key field is required.\",\n \"errors\": {\n \"key\": [\n \"The key field is required.\"\n ]\n }\n}" } ] }, { "name": "Show Page Content", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/:id", "host": [ "{{base_url}}" ], "path": [ "page-contents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/:id", "host": [ "{{base_url}}" ], "path": [ "page-contents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"key\": \"home.hero.title\",\n \"value\": \"Build your store in minutes\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/:id", "host": [ "{{base_url}}" ], "path": [ "page-contents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Update Page Content", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/:id", "host": [ "{{base_url}}" ], "path": [ "page-contents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"key\": \"home.hero.title\",\n \"value\": \"Launch your store today\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/:id", "host": [ "{{base_url}}" ], "path": [ "page-contents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"key\": \"home.hero.title\",\n \"value\": \"Launch your store today\",\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Content updated successfully\",\n \"data\": {\n \"id\": 1,\n \"key\": \"home.hero.title\",\n \"value\": \"Build your store in minutes\",\n \"locale\": \"en\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" } ] }, { "name": "Delete Page Content", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/:id", "host": [ "{{base_url}}" ], "path": [ "page-contents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/page-contents/:id", "host": [ "{{base_url}}" ], "path": [ "page-contents", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Content deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Email", "description": "Bulk email to tenants.", "item": [ { "name": "Send Bulk Email", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/email/send", "host": [ "{{base_url}}" ], "path": [ "email", "send" ] }, "description": "Send an email (subject + HTML body) to all tenants.", "body": { "mode": "raw", "raw": "{\n \"subject\": \"Scheduled maintenance\",\n \"body\": \"

We will be performing maintenance on...

\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/email/send", "host": [ "{{base_url}}" ], "path": [ "email", "send" ] }, "description": "Send an email (subject + HTML body) to all tenants.", "body": { "mode": "raw", "raw": "{\n \"subject\": \"Scheduled maintenance\",\n \"body\": \"

We will be performing maintenance on...

\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Emails queued successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/email/send", "host": [ "{{base_url}}" ], "path": [ "email", "send" ] }, "description": "Send an email (subject + HTML body) to all tenants.", "body": { "mode": "raw", "raw": "{\n \"subject\": \"Scheduled maintenance\",\n \"body\": \"

We will be performing maintenance on...

\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The subject field is required.\",\n \"errors\": {\n \"subject\": [\n \"The subject field is required.\"\n ]\n }\n}" } ] } ] }, { "name": "Support Tickets", "description": "Tenant support tickets.", "item": [ { "name": "List Tickets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets?per_page=15&search=&status=0", "host": [ "{{base_url}}" ], "path": [ "support", "tickets" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true }, { "key": "status", "value": "0", "description": "Filter by status (integer, e.g. 0=open, 1=closed)", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets?per_page=15&search=&status=0", "host": [ "{{base_url}}" ], "path": [ "support", "tickets" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "search", "value": "", "description": "Search term", "disabled": true }, { "key": "status", "value": "0", "description": "Filter by status (integer, e.g. 0=open, 1=closed)", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"subject\": \"Cannot access my store\",\n \"status\": 0,\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"messages\": [\n {\n \"id\": 1,\n \"message\": \"My storefront is showing a 500 error.\",\n \"sender\": \"tenant\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Show Ticket", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"subject\": \"Cannot access my store\",\n \"status\": 0,\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Acme Store\"\n },\n \"messages\": [\n {\n \"id\": 1,\n \"message\": \"My storefront is showing a 500 error.\",\n \"sender\": \"tenant\",\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Reply To Ticket", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id/reply", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id", "reply" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"message\": \"We have restarted your store services — please check again.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id/reply", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id", "reply" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"message\": \"We have restarted your store services — please check again.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Reply sent successfully\",\n \"data\": null\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id/reply", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id", "reply" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"message\": \"We have restarted your store services — please check again.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The message field is required.\",\n \"errors\": {\n \"message\": [\n \"The message field is required.\"\n ]\n }\n}" } ] }, { "name": "Close Ticket", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id/close", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id", "close" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id/close", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id", "close" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Ticket closed successfully\",\n \"data\": null\n}" } ] }, { "name": "Delete Ticket", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/support/tickets/:id", "host": [ "{{base_url}}" ], "path": [ "support", "tickets", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Ticket deleted successfully\",\n \"data\": null\n}" } ] } ] }, { "name": "Activity Logs", "description": "Audit trail of super admin and system actions.", "item": [ { "name": "List Activity Logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs?per_page=15&event=updated&subject_type=&causer_id=1&start_date=2026-07-01&end_date=2026-07-20", "host": [ "{{base_url}}" ], "path": [ "activity-logs" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "event", "value": "updated", "description": "Filter by event (created/updated/deleted...)", "disabled": true }, { "key": "subject_type", "value": "", "description": "Filter by subject model class", "disabled": true }, { "key": "causer_id", "value": "1", "description": "Filter by causer (agent) id", "disabled": true }, { "key": "start_date", "value": "2026-07-01", "description": "Filter from date", "disabled": true }, { "key": "end_date", "value": "2026-07-20", "description": "Filter to date", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs?per_page=15&event=updated&subject_type=&causer_id=1&start_date=2026-07-01&end_date=2026-07-20", "host": [ "{{base_url}}" ], "path": [ "activity-logs" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true }, { "key": "event", "value": "updated", "description": "Filter by event (created/updated/deleted...)", "disabled": true }, { "key": "subject_type", "value": "", "description": "Filter by subject model class", "disabled": true }, { "key": "causer_id", "value": "1", "description": "Filter by causer (agent) id", "disabled": true }, { "key": "start_date", "value": "2026-07-01", "description": "Filter from date", "disabled": true }, { "key": "end_date", "value": "2026-07-20", "description": "Filter to date", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"log_name\": \"default\",\n \"description\": \"updated\",\n \"event\": \"updated\",\n \"subject_type\": \"App\\\\Models\\\\Tenant\",\n \"subject_id\": 1,\n \"causer_type\": \"App\\\\Models\\\\SuperAdmin\",\n \"causer_id\": 1,\n \"causer\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\"\n },\n \"properties\": {\n \"attributes\": {\n \"is_active\": 1\n },\n \"old\": {\n \"is_active\": 0\n }\n },\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Log Statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/statistics?days=30", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "statistics" ], "query": [ { "key": "days", "value": "30", "description": "Window in days (default 30)", "disabled": true } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/statistics?days=30", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "statistics" ], "query": [ { "key": "days", "value": "30", "description": "Window in days (default 30)", "disabled": true } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"total\": 5230,\n \"by_event\": {\n \"created\": 1200,\n \"updated\": 3400,\n \"deleted\": 630\n }\n }\n}" } ] }, { "name": "Filter Options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/filter-options", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "filter-options" ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/filter-options", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "filter-options" ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"events\": [\n \"created\",\n \"updated\",\n \"deleted\"\n ],\n \"subject_types\": [\n \"App\\\\Models\\\\Tenant\",\n \"App\\\\Models\\\\SuperAdmin\"\n ],\n \"causers\": [\n {\n \"id\": 1,\n \"name\": \"Super Admin\"\n }\n ]\n }\n}" } ] }, { "name": "Logs By Company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/company/:companyId?per_page=15", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "company", ":companyId" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ], "variable": [ { "key": "companyId", "value": "1", "description": "The companyId" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/company/:companyId?per_page=15", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "company", ":companyId" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page (default 15)", "disabled": true } ], "variable": [ { "key": "companyId", "value": "1", "description": "The companyId" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"log_name\": \"default\",\n \"description\": \"updated\",\n \"event\": \"updated\",\n \"subject_type\": \"App\\\\Models\\\\Tenant\",\n \"subject_id\": 1,\n \"causer_type\": \"App\\\\Models\\\\SuperAdmin\",\n \"causer_id\": 1,\n \"causer\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\"\n },\n \"properties\": {\n \"attributes\": {\n \"is_active\": 1\n },\n \"old\": {\n \"is_active\": 0\n }\n },\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n ],\n \"first_page_url\": \"{{base_url}}/...?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"{{base_url}}/...?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"{{base_url}}/...\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n }\n}" } ] }, { "name": "Show Activity Log", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/:id", "host": [ "{{base_url}}" ], "path": [ "activity-logs", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/:id", "host": [ "{{base_url}}" ], "path": [ "activity-logs", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"data\": {\n \"id\": 1,\n \"log_name\": \"default\",\n \"description\": \"updated\",\n \"event\": \"updated\",\n \"subject_type\": \"App\\\\Models\\\\Tenant\",\n \"subject_id\": 1,\n \"causer_type\": \"App\\\\Models\\\\SuperAdmin\",\n \"causer_id\": 1,\n \"causer\": {\n \"id\": 1,\n \"first_name\": \"Super\",\n \"last_name\": \"Admin\"\n },\n \"properties\": {\n \"attributes\": {\n \"is_active\": 1\n },\n \"old\": {\n \"is_active\": 0\n }\n },\n \"created_at\": \"2026-01-15T10:00:00.000000Z\"\n }\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/:id", "host": [ "{{base_url}}" ], "path": [ "activity-logs", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The id" } ] }, "description": "" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Error\",\n \"message\": \"Resource not found\",\n \"data\": null\n}" } ] }, { "name": "Cleanup Old Logs", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/cleanup", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "cleanup" ] }, "description": "Delete logs older than `days_to_keep` days.", "body": { "mode": "raw", "raw": "{\n \"days_to_keep\": 90\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/cleanup", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "cleanup" ] }, "description": "Delete logs older than `days_to_keep` days.", "body": { "mode": "raw", "raw": "{\n \"days_to_keep\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Success\",\n \"message\": \"Old logs cleaned up successfully\",\n \"data\": {\n \"deleted\": 1520\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-locale", "value": "{{locale}}", "description": "Optional. Sets the response locale (falls back to default channel locale, then en)." } ], "url": { "raw": "{{base_url}}/activity-logs/cleanup", "host": [ "{{base_url}}" ], "path": [ "activity-logs", "cleanup" ] }, "description": "Delete logs older than `days_to_keep` days.", "body": { "mode": "raw", "raw": "{\n \"days_to_keep\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The days_to_keep field is required.\",\n \"errors\": {\n \"days_to_keep\": [\n \"The days_to_keep field is required.\"\n ]\n }\n}" } ] } ] } ], "variable": [ { "key": "base_url", "value": "http://localhost:8000/api/v1/super" } ] }