{ "info": { "_postman_id": "admin-api-v1", "name": "Admin REST API - Complete Collection", "description": "# Admin REST API - Complete Collection\n\n**Base URL:** `{{base_url}}/api/v1/admin`\n\n**Authentication:** Sanctum bearer token (set in collection auth)\n\n**Tenant Scoping:** All endpoints automatically scoped by `company_id`\n\n## Modules\n- ✅ **Sale Module** (34 endpoints)\n- ✅ **Customer Module** (35 endpoints)\n- ✅ **Dashboard Module** (5 endpoints)\n- ✅ **Catalog Module** (48 endpoints)\n- ⏳ **Marketing Module**\n- ⏳ **CMS Module**\n- ⏳ **Settings Module**\n\n## How to Use\n1. Set `{{base_url}}` variable (e.g., http://localhost)\n2. Set `{{bearer_token}}` variable (obtain from login endpoint)\n3. All requests will automatically use bearer token authentication\n4. Update ID variables (order_id, invoice_id, etc.) as needed", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearer_token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "http://localhost", "type": "string" }, { "key": "bearer_token", "value": "", "type": "string" }, { "key": "order_id", "value": "1", "type": "string" }, { "key": "invoice_id", "value": "1", "type": "string" }, { "key": "shipment_id", "value": "1", "type": "string" }, { "key": "refund_id", "value": "1", "type": "string" }, { "key": "transaction_id", "value": "1", "type": "string" }, { "key": "customer_id", "value": "1", "type": "string" }, { "key": "address_id", "value": "1", "type": "string" }, { "key": "group_id", "value": "1", "type": "string" }, { "key": "review_id", "value": "1", "type": "string" }, { "key": "contact_id", "value": "1", "type": "string" }, { "key": "product_id", "value": "1", "type": "string" }, { "key": "category_id", "value": "1", "type": "string" }, { "key": "attribute_id", "value": "1", "type": "string" }, { "key": "attribute_family_id", "value": "1", "type": "string" } ], "item": [ { "name": "Sale Module", "description": "# Sale Module\n\n**Purpose:** Complete order lifecycle management\n\n**Domains:** Orders, Invoices, Shipments, Refunds, Transactions", "item": [ { "name": "Orders", "description": "# Orders\n\nManage complete order lifecycle", "item": [ { "name": "List Orders", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders"] }, "description": "**Purpose:** Retrieve paginated list of orders\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders`\n- **Component:** OrderList\n- **Trigger:** Page load, pagination\n\n**Blade Reference:** `OrderController@index`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Order", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/{{order_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "{{order_id}}"] }, "description": "**Purpose:** Retrieve single order by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderDetail\n- **Trigger:** Order detail page load\n\n**Blade Reference:** `OrderController@view`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Order ID" } }, { "name": "Search Orders", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"John\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "search"] }, "description": "**Purpose:** Search orders by customer name, order number, or status\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders`\n- **Component:** OrderSearch\n- **Trigger:** Search input change\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } }, { "name": "Cancel Order", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/{{order_id}}/cancel", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "{{order_id}}", "cancel"] }, "description": "**Purpose:** Cancel order and log cancellation in activity timeline\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderActions\n- **Trigger:** Cancel button click\n\n**Blade Reference:** `OrderController@cancel`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Order ID" } }, { "name": "Complete Order", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/{{order_id}}/complete", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "{{order_id}}", "complete"] }, "description": "**Purpose:** Mark order as completed and log completion in activity timeline\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderActions\n- **Trigger:** Complete button click\n\n**Blade Reference:** `OrderController@complete`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Order ID" } }, { "name": "Fast Complete Order", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/{{order_id}}/fastComplete", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "{{order_id}}", "fastComplete"] }, "description": "**Purpose:** Create invoice, shipment (if needed), and complete order in single transaction\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderActions\n- **Trigger:** Fast Complete button click\n\n**Blade Reference:** `OrderController@fastComplete`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Order ID" } }, { "name": "Add Comment to Order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"Customer requested expedited shipping\",\n \"customer_notified\": 1\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/{{order_id}}/comments", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "{{order_id}}", "comments"] }, "description": "**Purpose:** Add comment to order with optional customer notification\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderComments\n- **Trigger:** Add Comment button click\n\n**Blade Reference:** `OrderController@addComment`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Order ID\n- **comment** (body, string, required): Comment text\n- **customer_notified** (body, boolean, optional): Notify customer (1 or 0)" } }, { "name": "Get Order Timeline", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/order-timeline/{{order_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "order-timeline", "{{order_id}}"] }, "description": "**Purpose:** Retrieve order activity timeline with translated status labels\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderTimeline\n- **Trigger:** Order detail page load\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Order ID" } }, { "name": "Ship Order (Multi-Source)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"carrier_title\": \"smsa\",\n \"track_number\": \"TRACK123\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/{{order_id}}/ship", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "{{order_id}}", "ship"] }, "description": "**Purpose:** Ship order using automatic multi-source inventory allocation\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderActions\n- **Trigger:** Ship button click\n\n**Blade Reference:** Similar to `fastShip`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Order ID\n- **carrier_title** (body, string, optional): Carrier code (smsa, mylerz, dhl, dpd, bosta, rtx, jnt)\n- **track_number** (body, string, optional): Tracking number" } }, { "name": "Create Manual Order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"related_products\": [\"123-456\", \"789\"],\n \"qty\": [2, 1],\n \"branchId\": 1,\n \"customer_id\": 5,\n \"address_id\": 10,\n \"shipping_method\": \"flatrate_flatrate\",\n \"paymentMethod\": \"cashondelivery\",\n \"token\": \"csrf-token-here\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/orders/store", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "orders", "store"] }, "description": "**Purpose:** Create manual (admin) order with automatic invoice generation\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/create`\n- **Component:** ManualOrderForm\n- **Trigger:** Create Order button click\n\n**Blade Reference:** `OrderController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **related_products** (body, array, required): Product IDs\n- **qty** (body, array, required): Quantities\n- **branchId** (body, integer, required): Source/branch ID\n- **customer_id** (body, integer, required): Customer ID\n- **address_id** (body, integer, required): Shipping address ID\n- **shipping_method** (body, string, required): Shipping method code\n- **paymentMethod** (body, string, required): Payment method code\n- **token** (body, string, required): CSRF token" } }, { "name": "Get Shipping Rates", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/shippingRates", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "shippingRates"] }, "description": "**Purpose:** Collect grouped shipping rates from all configured carriers\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/create`\n- **Component:** ShippingMethodSelector\n- **Trigger:** Shipping method dropdown load\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Source Shipment Availability", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/shipment/source/{{order_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "shipment", "source", "{{order_id}}"] }, "description": "**Purpose:** Get per-source shippable quantity breakdown for order items\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** ShipmentModal\n- **Trigger:** Create Shipment button click\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **order_id** (path, integer, required): Order ID" } }, { "name": "Get Refund Creation Data", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/refund/create/{{order_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "refund", "create", "{{order_id}}"] }, "description": "**Purpose:** Get data needed to create a refund (addresses, payment, items)\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** RefundModal\n- **Trigger:** Create Refund button click\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **order_id** (path, integer, required): Order ID" } } ] }, { "name": "Invoices", "description": "# Invoices\n\nManage invoice creation, viewing, and printing", "item": [ { "name": "List Invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/invoices", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "invoices"] }, "description": "**Purpose:** Retrieve paginated list of invoices\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/invoices`\n- **Component:** InvoiceList\n- **Trigger:** Page load, pagination\n\n**Blade Reference:** `InvoiceController@index`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Invoice", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/invoices/{{invoice_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "invoices", "{{invoice_id}}"] }, "description": "**Purpose:** Retrieve single invoice by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/invoices/{id}`\n- **Component:** InvoiceDetail\n- **Trigger:** Invoice detail page load\n\n**Blade Reference:** `InvoiceController@view`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Invoice ID" } }, { "name": "Search Invoices", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"1500\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/invoice/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "invoice", "search"] }, "description": "**Purpose:** Search invoices by order ID, total, or state\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/invoices`\n- **Component:** InvoiceSearch\n- **Trigger:** Search input change\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } }, { "name": "Create Invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"items\": {\n \"1\": 2,\n \"2\": 1\n }\n }\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/invoices/{{order_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "invoices", "{{order_id}}"] }, "description": "**Purpose:** Create invoice for order\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderActions\n- **Trigger:** Create Invoice button\n\n**Blade Reference:** `InvoiceController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **order_id** (path, integer, required): Order ID\n- **invoice.items** (body, object, required): Maps order item IDs to quantities" } }, { "name": "Print Invoice (HTML)", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/invoice/print/{{invoice_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "invoice", "print", "{{invoice_id}}"] }, "description": "**Purpose:** Get printable invoice HTML\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/invoices/{id}`\n- **Component:** InvoiceActions\n- **Trigger:** Print button\n\n**Blade Reference:** `InvoiceController@print`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Invoice ID" } }, { "name": "Get Invoice Transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/invoice/transaction/{{invoice_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "invoice", "transaction", "{{invoice_id}}"] }, "description": "**Purpose:** Get transactions linked to invoice\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/invoices/{id}`\n- **Component:** InvoiceTransactions\n- **Trigger:** Transactions tab load\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Invoice ID" } } ] }, { "name": "Shipments", "description": "# Shipments\n\nManage shipment creation and tracking", "item": [ { "name": "List Shipments", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/shipments", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "shipments"] }, "description": "**Purpose:** Retrieve paginated list of shipments\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/shipments`\n- **Component:** ShipmentList\n- **Trigger:** Page load\n\n**Blade Reference:** `ShipmentController@index`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Shipment", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/shipments/{{shipment_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "shipments", "{{shipment_id}}"] }, "description": "**Purpose:** Retrieve single shipment by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/shipments/{id}`\n- **Component:** ShipmentDetail\n- **Trigger:** Shipment detail page load\n\n**Blade Reference:** `ShipmentController@view`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Shipment ID" } }, { "name": "Search Shipments", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"123\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/shipment/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "shipment", "search"] }, "description": "**Purpose:** Search shipments by order ID or shipment ID\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/shipments`\n- **Component:** ShipmentSearch\n- **Trigger:** Search input\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } }, { "name": "Create Shipment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shipment\": {\n \"source\": 1,\n \"carrier_title\": \"carriers.smsa\",\n \"items\": {\n \"1\": {\n \"1\": 2\n }\n }\n }\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/shipments/{{order_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "shipments", "{{order_id}}"] }, "description": "**Purpose:** Create shipment for order\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** ShipmentModal\n- **Trigger:** Create Shipment button\n\n**Blade Reference:** `ShipmentController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **order_id** (path, integer, required): Order ID\n- **shipment.source** (body, integer, required): Source/warehouse ID\n- **shipment.carrier_title** (body, string, required): Carrier key (carriers.smsa, carriers.mylerz, etc.)\n- **shipment.items** (body, object, required): Maps order item IDs to source IDs to quantities" } } ] }, { "name": "Refunds", "description": "# Refunds\n\nProcess full or partial refunds", "item": [ { "name": "List Refunds", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/refunds", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "refunds"] }, "description": "**Purpose:** Retrieve paginated list of refunds\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/refunds`\n- **Component:** RefundList\n- **Trigger:** Page load\n\n**Blade Reference:** `RefundController@index`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Refund", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/refunds/{{refund_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "refunds", "{{refund_id}}"] }, "description": "**Purpose:** Retrieve single refund by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/refunds/{id}`\n- **Component:** RefundDetail\n- **Trigger:** Refund detail page load\n\n**Blade Reference:** `RefundController@view`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Refund ID" } }, { "name": "Search Refunds", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"123\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/refund/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "refund", "search"] }, "description": "**Purpose:** Search refunds by refund ID or order ID\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/refunds`\n- **Component:** RefundSearch\n- **Trigger:** Search input\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } }, { "name": "Create Refund", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"refund\": {\n \"items\": {\n \"1\": 2,\n \"2\": 1\n },\n \"shipping\": 10.00,\n \"adjustment_refund\": 0,\n \"adjustment_fee\": 0\n }\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/refunds/orderItems/{{order_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "refunds", "orderItems", "{{order_id}}"] }, "description": "**Purpose:** Create refund for order\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** RefundModal\n- **Trigger:** Create Refund button\n\n**Blade Reference:** `RefundController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **order_id** (path, integer, required): Order ID\n- **refund.items** (body, object, required): Maps order item IDs to quantities to refund\n- **refund.shipping** (body, number, optional): Shipping amount to refund\n- **refund.adjustment_refund** (body, number, optional): Adjustment refund\n- **refund.adjustment_fee** (body, number, optional): Adjustment fee" } }, { "name": "Fast Refund", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/refunds/{{order_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "refunds", "{{order_id}}"] }, "description": "**Purpose:** Automatically refund all refundable items including shipping\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/{id}`\n- **Component:** OrderActions\n- **Trigger:** Fast Refund button\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **order_id** (path, integer, required): Order ID" } } ] }, { "name": "Transactions", "description": "# Transactions\n\nRecord payment transactions", "item": [ { "name": "List Transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/transactions", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "transactions"] }, "description": "**Purpose:** Retrieve paginated list of transactions\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/transactions`\n- **Component:** TransactionList\n- **Trigger:** Page load\n\n**Blade Reference:** `TransactionController@index`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Transaction", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/sales/transactions/{{transaction_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "transactions", "{{transaction_id}}"] }, "description": "**Purpose:** Retrieve single transaction by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/transactions/{id}`\n- **Component:** TransactionDetail\n- **Trigger:** Transaction detail page load\n\n**Blade Reference:** `TransactionController@view`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Transaction ID" } }, { "name": "Search Transactions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"abc123\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/transactions/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "transactions", "search"] }, "description": "**Purpose:** Search transactions by transaction ID or order ID\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/transactions`\n- **Component:** TransactionSearch\n- **Trigger:** Search input\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } }, { "name": "Create Transaction", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"invoice_id\": \"INV-2024-001\",\n \"payment_method\": \"cashondelivery\",\n \"amount\": 150.00\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/transactions", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "transactions"] }, "description": "**Purpose:** Record payment transaction against invoice\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/invoices/{id}`\n- **Component:** TransactionForm\n- **Trigger:** Record Payment button\n\n**Blade Reference:** `TransactionController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **invoice_id** (body, string, required): Invoice number\n- **payment_method** (body, string, required): Payment method code\n- **amount** (body, number, required): Payment amount" } } ] }, { "name": "Customer Helper", "description": "# Customer Helper\n\nHelper endpoints for manual order creation", "item": [ { "name": "Create Customer and Address", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+1234567890\",\n \"address1\": \"123 Main St\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"state\": \"NY\",\n \"postcode\": \"10001\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/sales/customers/createCustomerAndAddress", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "sales", "customers", "createCustomerAndAddress"] }, "description": "**Purpose:** Create customer and address in one call for manual order creation\n\n**Frontend Usage:**\n- **Page:** `/admin/sales/orders/create`\n- **Component:** ManualOrderForm\n- **Trigger:** Create New Customer button\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **first_name** (body, string, required): Customer first name\n- **last_name** (body, string, required): Customer last name\n- **email** (body, string, required): Customer email\n- **phone** (body, string, required): Customer phone\n- **address1** (body, string, required): Address line 1\n- **city** (body, string, required): City\n- **country** (body, string, required): Country code\n- **state** (body, string, required): State/province\n- **postcode** (body, string, required): Postal code" } } ] } ] }, { "name": "Customer Module", "description": "# Customer Module\n\n**Purpose:** Manage customers, groups, reviews, addresses, and support contacts\n\n**Domains:** Customers, Customer Groups, Customer Reviews, Customer Addresses, Contact Support", "item": [ { "name": "Customers", "description": "# Customers\n\nManage customer accounts and related data", "item": [ { "name": "List Customers", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers"] }, "description": "**Purpose:** Retrieve paginated list of customers\n\n**Frontend Usage:**\n- **Page:** `/admin/customers`\n- **Component:** CustomerList\n- **Trigger:** Page load, pagination\n\n**Blade Reference:** `CustomerController@index`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Customer", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}"] }, "description": "**Purpose:** Retrieve single customer by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerDetail\n- **Trigger:** Customer detail page load\n\n**Blade Reference:** `CustomerController@view`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Customer ID" } }, { "name": "Create Customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+1234567890\",\n \"customer_group_id\": 1\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers"] }, "description": "**Purpose:** Create new customer\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/create`\n- **Component:** CustomerForm\n- **Trigger:** Create Customer button\n\n**Blade Reference:** `CustomerController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **first_name** (body, string, required): First name\n- **last_name** (body, string, required): Last name\n- **email** (body, string, required): Email address\n- **phone** (body, string, optional): Phone number\n- **customer_group_id** (body, integer, optional): Customer group ID" } }, { "name": "Update Customer", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+1234567890\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}"] }, "description": "**Purpose:** Update customer information\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}/edit`\n- **Component:** CustomerForm\n- **Trigger:** Update Customer button\n\n**Blade Reference:** `CustomerController@update`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Customer ID\n- **first_name** (body, string, optional): First name\n- **last_name** (body, string, optional): Last name\n- **email** (body, string, optional): Email address\n- **phone** (body, string, optional): Phone number" } }, { "name": "Delete Customer", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}"] }, "description": "**Purpose:** Delete customer\n\n**Frontend Usage:**\n- **Page:** `/admin/customers`\n- **Component:** CustomerList\n- **Trigger:** Delete button\n\n**Blade Reference:** `CustomerController@destroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Customer ID" } }, { "name": "Search Customers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"John\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "search"] }, "description": "**Purpose:** Search customers by name or email\n\n**Frontend Usage:**\n- **Page:** `/admin/customers`\n- **Component:** CustomerSearch\n- **Trigger:** Search input change\n\n**Blade Reference:** API-only\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } }, { "name": "Mass Delete Customers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"indices\": [1, 2, 3]\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/mass-destroy", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "mass-destroy"] }, "description": "**Purpose:** Delete multiple customers at once\n\n**Frontend Usage:**\n- **Page:** `/admin/customers`\n- **Component:** CustomerList\n- **Trigger:** Mass Delete button\n\n**Blade Reference:** `CustomerController@massDestroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **indices** (body, array, required): Array of customer IDs" } }, { "name": "Mass Update Customers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"indices\": [1, 2, 3],\n \"value\": 2\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/mass-update", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "mass-update"] }, "description": "**Purpose:** Update multiple customers at once\n\n**Frontend Usage:**\n- **Page:** `/admin/customers`\n- **Component:** CustomerList\n- **Trigger:** Mass Update button\n\n**Blade Reference:** `CustomerController@massUpdate`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **indices** (body, array, required): Array of customer IDs\n- **value** (body, integer, required): New customer group ID" } }, { "name": "Get Customer Orders", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/orders", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "orders"] }, "description": "**Purpose:** Get all orders for a customer\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerOrders\n- **Trigger:** Orders tab load\n\n**Blade Reference:** `CustomerController@orders`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Customer ID" } }, { "name": "Search Customer Orders", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"ORD-123\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/orders/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "orders", "search"] }, "description": "**Purpose:** Search customer orders\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerOrders\n- **Trigger:** Search input\n\n**Blade Reference:** `CustomerController@searchOrders`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Customer ID\n- **search_key** (body, string, required): Search term" } }, { "name": "Get Customer Invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/invoices", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "invoices"] }, "description": "**Purpose:** Get all invoices for a customer\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerInvoices\n- **Trigger:** Invoices tab load\n\n**Blade Reference:** `CustomerController@invoices`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Customer ID" } }, { "name": "Search Customer Invoices", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"INV-123\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/invoices/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "invoices", "search"] }, "description": "**Purpose:** Search customer invoices\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerInvoices\n- **Trigger:** Search input\n\n**Blade Reference:** `CustomerController@searchInvoices`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Customer ID\n- **search_key** (body, string, required): Search term" } }, { "name": "Add Customer Note", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"Customer prefers morning deliveries\",\n \"customer_notified\": 0\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/notes", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "notes"] }, "description": "**Purpose:** Add note to customer account\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerNotes\n- **Trigger:** Add Note button\n\n**Blade Reference:** `CustomerController@storeNote`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Customer ID\n- **note** (body, string, required): Note text\n- **customer_notified** (body, boolean, optional): Notify customer" } }, { "name": "Get Review Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/review-status", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "review-status"] }, "description": "**Purpose:** Get available review status options\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/reviews`\n- **Component:** ReviewStatusFilter\n- **Trigger:** Filter dropdown load\n\n**Blade Reference:** `CustomerController@getReviewStatus`\n\n**Authentication:** Sanctum bearer token, admin role required" } } ] }, { "name": "Customer Addresses", "description": "# Customer Addresses\n\nManage customer shipping and billing addresses", "item": [ { "name": "List Customer Addresses", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/addresses", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "addresses"] }, "description": "**Purpose:** Get all addresses for a customer\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerAddresses\n- **Trigger:** Addresses tab load\n\n**Blade Reference:** `CustomerAddressController@index`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **customer_id** (path, integer, required): Customer ID" } }, { "name": "Get Single Address", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/addresses/{{address_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "addresses", "{{address_id}}"] }, "description": "**Purpose:** Get single address by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}/addresses/{address_id}`\n- **Component:** AddressDetail\n- **Trigger:** Address detail view\n\n**Blade Reference:** `CustomerAddressController@show`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **customer_id** (path, integer, required): Customer ID\n- **id** (path, integer, required): Address ID" } }, { "name": "Create Address", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address1\": \"123 Main St\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"state\": \"NY\",\n \"postcode\": \"10001\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/addresses", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "addresses"] }, "description": "**Purpose:** Create new address for customer\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** AddressForm\n- **Trigger:** Add Address button\n\n**Blade Reference:** `CustomerAddressController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **customer_id** (path, integer, required): Customer ID\n- **address1** (body, string, required): Address line 1\n- **city** (body, string, required): City\n- **country** (body, string, required): Country code\n- **state** (body, string, required): State/province\n- **postcode** (body, string, required): Postal code" } }, { "name": "Update Address", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address1\": \"123 Main St\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"state\": \"NY\",\n \"postcode\": \"10001\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/addresses/{{address_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "addresses", "{{address_id}}"] }, "description": "**Purpose:** Update customer address\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}/addresses/{address_id}/edit`\n- **Component:** AddressForm\n- **Trigger:** Update Address button\n\n**Blade Reference:** `CustomerAddressController@update`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **customer_id** (path, integer, required): Customer ID\n- **id** (path, integer, required): Address ID\n- **address1** (body, string, optional): Address line 1\n- **city** (body, string, optional): City\n- **country** (body, string, optional): Country code\n- **state** (body, string, optional): State/province\n- **postcode** (body, string, optional): Postal code" } }, { "name": "Delete Address", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/addresses/{{address_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "addresses", "{{address_id}}"] }, "description": "**Purpose:** Delete customer address\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerAddresses\n- **Trigger:** Delete button\n\n**Blade Reference:** `CustomerAddressController@destroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **customer_id** (path, integer, required): Customer ID\n- **id** (path, integer, required): Address ID" } }, { "name": "Mass Delete Addresses", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"indices\": [1, 2, 3]\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/addresses/mass-destroy", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "addresses", "mass-destroy"] }, "description": "**Purpose:** Delete multiple addresses at once\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerAddresses\n- **Trigger:** Mass Delete button\n\n**Blade Reference:** `CustomerAddressController@massDestroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **customer_id** (path, integer, required): Customer ID\n- **indices** (body, array, required): Array of address IDs" } }, { "name": "Search Addresses", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"New York\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/{{customer_id}}/searchAdresses", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "{{customer_id}}", "searchAdresses"] }, "description": "**Purpose:** Search customer addresses\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/{id}`\n- **Component:** CustomerAddresses\n- **Trigger:** Search input\n\n**Blade Reference:** `CustomerAddressController@searchAdresses`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **customer_id** (path, integer, required): Customer ID\n- **search_key** (body, string, required): Search term" } } ] }, { "name": "Customer Groups", "description": "# Customer Groups\n\nManage customer groups for segmentation", "item": [ { "name": "List Customer Groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/groups", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "groups"] }, "description": "**Purpose:** Get all customer groups\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/groups`\n- **Component:** CustomerGroupList\n- **Trigger:** Page load\n\n**Blade Reference:** `CustomerGroupController@index`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Customer Group", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/groups/{{group_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "groups", "{{group_id}}"] }, "description": "**Purpose:** Get single customer group by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/groups/{id}`\n- **Component:** CustomerGroupDetail\n- **Trigger:** Group detail page load\n\n**Blade Reference:** `CustomerGroupController@view`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Group ID" } }, { "name": "Create Customer Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"vip\",\n \"name\": \"VIP Customers\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/groups", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "groups"] }, "description": "**Purpose:** Create new customer group\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/groups/create`\n- **Component:** CustomerGroupForm\n- **Trigger:** Create Group button\n\n**Blade Reference:** `CustomerGroupController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **code** (body, string, required): Group code\n- **name** (body, string, required): Group name" } }, { "name": "Update Customer Group", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"vip\",\n \"name\": \"VIP Customers\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/groups/{{group_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "groups", "{{group_id}}"] }, "description": "**Purpose:** Update customer group\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/groups/{id}/edit`\n- **Component:** CustomerGroupForm\n- **Trigger:** Update Group button\n\n**Blade Reference:** `CustomerGroupController@update`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Group ID\n- **code** (body, string, optional): Group code\n- **name** (body, string, optional): Group name" } }, { "name": "Delete Customer Group", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/groups/{{group_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "groups", "{{group_id}}"] }, "description": "**Purpose:** Delete customer group\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/groups`\n- **Component:** CustomerGroupList\n- **Trigger:** Delete button\n\n**Blade Reference:** `CustomerGroupController@destroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Group ID" } }, { "name": "Search Customer Groups", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"VIP\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/groups-search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "groups-search"] }, "description": "**Purpose:** Search customer groups\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/groups`\n- **Component:** CustomerGroupSearch\n- **Trigger:** Search input\n\n**Blade Reference:** `CustomerGroupController@searchGroup`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } } ] }, { "name": "Customer Reviews", "description": "# Customer Reviews\n\nManage product reviews submitted by customers", "item": [ { "name": "List Customer Reviews", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/reviews", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "reviews"] }, "description": "**Purpose:** Get paginated list of customer reviews\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/reviews`\n- **Component:** ReviewList\n- **Trigger:** Page load\n\n**Blade Reference:** `CustomerReviewController@index`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Review", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/reviews/{{review_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "reviews", "{{review_id}}"] }, "description": "**Purpose:** Get single review by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/reviews/{id}`\n- **Component:** ReviewDetail\n- **Trigger:** Review detail page load\n\n**Blade Reference:** `CustomerReviewController@view`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Review ID" } }, { "name": "Update Review", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"approved\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/reviews/{{review_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "reviews", "{{review_id}}"] }, "description": "**Purpose:** Update review status or content\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/reviews/{id}/edit`\n- **Component:** ReviewForm\n- **Trigger:** Update Review button\n\n**Blade Reference:** `CustomerReviewController@update`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Review ID\n- **status** (body, string, optional): Review status" } }, { "name": "Delete Review", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/reviews/{{review_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "reviews", "{{review_id}}"] }, "description": "**Purpose:** Delete customer review\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/reviews`\n- **Component:** ReviewList\n- **Trigger:** Delete button\n\n**Blade Reference:** `CustomerReviewController@destroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Review ID" } }, { "name": "Search Reviews", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"excellent\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/reviews/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "reviews", "search"] }, "description": "**Purpose:** Search customer reviews\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/reviews`\n- **Component:** ReviewSearch\n- **Trigger:** Search input\n\n**Blade Reference:** `CustomerReviewController@searchReviews`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } }, { "name": "Mass Delete Reviews", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"indices\": [1, 2, 3]\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/reviews/mass-destroy", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "reviews", "mass-destroy"] }, "description": "**Purpose:** Delete multiple reviews at once\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/reviews`\n- **Component:** ReviewList\n- **Trigger:** Mass Delete button\n\n**Blade Reference:** `CustomerReviewController@massDestroyResources`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **indices** (body, array, required): Array of review IDs" } }, { "name": "Mass Update Reviews", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"indices\": [1, 2, 3],\n \"value\": \"approved\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/reviews/mass-update", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "reviews", "mass-update"] }, "description": "**Purpose:** Update multiple reviews at once\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/reviews`\n- **Component:** ReviewList\n- **Trigger:** Mass Update button\n\n**Blade Reference:** `CustomerReviewController@massUpdate`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **indices** (body, array, required): Array of review IDs\n- **value** (body, string, required): New status value" } } ] }, { "name": "Contact Support", "description": "# Contact Support\n\nManage customer support tickets and inquiries", "item": [ { "name": "List Contact Tickets", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/contact", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "contact"] }, "description": "**Purpose:** Get all customer contact tickets\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/contact`\n- **Component:** ContactList\n- **Trigger:** Page load\n\n**Blade Reference:** `ContactController@get`\n\n**Authentication:** Sanctum bearer token, admin role required" } }, { "name": "Get Single Contact Ticket", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/contact/{{contact_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "contact", "{{contact_id}}"] }, "description": "**Purpose:** Get single contact ticket by ID\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/contact/{id}`\n- **Component:** ContactDetail\n- **Trigger:** Ticket detail page load\n\n**Blade Reference:** `ContactController@getById`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Contact ticket ID" } }, { "name": "Reply to Contact Ticket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"Thank you for contacting us. We will resolve this issue shortly.\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/contact/{{contact_id}}/reply", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "contact", "{{contact_id}}", "reply"] }, "description": "**Purpose:** Send reply to customer contact ticket\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/contact/{id}`\n- **Component:** ContactReply\n- **Trigger:** Send Reply button\n\n**Blade Reference:** `ContactController@sendMessageReply`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Contact ticket ID\n- **message** (body, string, required): Reply message" } }, { "name": "Close Contact Ticket", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/contact/{{contact_id}}/close", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "contact", "{{contact_id}}", "close"] }, "description": "**Purpose:** Close customer contact ticket\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/contact/{id}`\n- **Component:** ContactActions\n- **Trigger:** Close Ticket button\n\n**Blade Reference:** `ContactController@closeTicket`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Contact ticket ID" } }, { "name": "Search Contact Tickets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"refund\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/customers/contact/search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "contact", "search"] }, "description": "**Purpose:** Search contact tickets\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/contact`\n- **Component:** ContactSearch\n- **Trigger:** Search input\n\n**Blade Reference:** `ContactController@searchContact`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } }, { "name": "Delete Contact Ticket", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/customers/contact/{{contact_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "customers", "contact", "{{contact_id}}"] }, "description": "**Purpose:** Delete contact ticket\n\n**Frontend Usage:**\n- **Page:** `/admin/customers/contact`\n- **Component:** ContactList\n- **Trigger:** Delete button\n\n**Blade Reference:** `ContactController@delete`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Contact ticket ID" } } ] } ] }, { "name": "Dashboard Module", "description": "# Dashboard Module\n\n**Purpose:** Analytics and business intelligence data\n\n**Domains:** Statistics, Reports, Top Performers", "item": [ { "name": "Get Dashboard Statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/statistics?start=2024-01-01&end=2024-01-31", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "dashboard", "statistics"], "query": [ { "key": "start", "value": "2024-01-01", "description": "Start date (optional, defaults to 30 days ago)" }, { "key": "end", "value": "2024-01-31", "description": "End date (optional, defaults to today)" } ] }, "description": "**Purpose:** Get comprehensive dashboard statistics including customers, orders, sales, and graphs\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** DashboardStats\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@index`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **start** (query, date, optional): Start date for statistics (defaults to 30 days ago)\n- **end** (query, date, optional): End date for statistics (defaults to today)" } }, { "name": "Get Top Selling Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/top-selling-categories?start=2024-01-01&end=2024-01-31", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "dashboard", "top-selling-categories"], "query": [ { "key": "start", "value": "2024-01-01", "description": "Start date (optional)" }, { "key": "end", "value": "2024-01-31", "description": "End date (optional)" } ] }, "description": "**Purpose:** Get top 5 selling categories by quantity sold\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** TopSellingCategories\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@getTopSellingCategories`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **start** (query, date, optional): Start date\n- **end** (query, date, optional): End date" } }, { "name": "Get Top Selling Products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/top-selling-products?start=2024-01-01&end=2024-01-31", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "dashboard", "top-selling-products"], "query": [ { "key": "start", "value": "2024-01-01", "description": "Start date (optional)" }, { "key": "end", "value": "2024-01-31", "description": "End date (optional)" } ] }, "description": "**Purpose:** Get top 5 selling products with revenue data\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** TopSellingProducts\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@getTopSellingProducts`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **start** (query, date, optional): Start date\n- **end** (query, date, optional): End date" } }, { "name": "Get Customers with Most Sales", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/customer-with-most-sales?start=2024-01-01&end=2024-01-31", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "dashboard", "customer-with-most-sales"], "query": [ { "key": "start", "value": "2024-01-01", "description": "Start date (optional)" }, { "key": "end", "value": "2024-01-31", "description": "End date (optional)" } ] }, "description": "**Purpose:** Get top 5 customers by total order value\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** TopCustomers\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@getCustomerWithMostSales`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **start** (query, date, optional): Start date\n- **end** (query, date, optional): End date" } }, { "name": "Get Low Stock Products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/stock-threshold", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "dashboard", "stock-threshold"] }, "description": "**Purpose:** Get products with lowest stock quantities (top 5)\n\n**Frontend Usage:**\n- **Page:** `/admin/dashboard`\n- **Component:** LowStockAlert\n- **Trigger:** Page load\n\n**Blade Reference:** `DashboardController@getStockThreshold`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:** None" } } ] }, { "name": "Catalog Module", "description": "# Catalog Module\n\n**Purpose:** Product catalog management\n\n**Domains:** Products, Categories, Attributes, Attribute Families", "item": [ { "name": "Products", "description": "# Products\n\nManage product catalog", "item": [ { "name": "List Products", "request": { "method": "GET", "header": [{"key": "Accept", "value": "application/json"}], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/products?limit=10&page=1", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "products"], "query": [ {"key": "limit", "value": "10"}, {"key": "page", "value": "1"} ] }, "description": "**Purpose:** Get paginated list of products\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/products`\n- **Component:** ProductList\n- **Trigger:** Page load\n\n**Blade Reference:** `ProductController@getAllResources`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **limit** (query, integer, optional): Items per page\n- **page** (query, integer, optional): Page number" } }, { "name": "Create Product", "request": { "method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"type\": \"simple\",\n \"attribute_family_id\": 1,\n \"sku\": \"PROD-001\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/products", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "products"] }, "description": "**Purpose:** Create new product\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/products/create`\n- **Component:** ProductForm\n- **Trigger:** Save button\n\n**Blade Reference:** `ProductController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **type** (body, string, required): Product type (simple, configurable, etc.)\n- **attribute_family_id** (body, integer, required): Attribute family ID\n- **sku** (body, string, required): Product SKU" } }, { "name": "Get Product", "request": { "method": "GET", "header": [{"key": "Accept", "value": "application/json"}], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/products/{{product_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "products", "{{product_id}}"] }, "description": "**Purpose:** Get product details\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/products/edit/{id}`\n- **Component:** ProductEdit\n- **Trigger:** Page load\n\n**Blade Reference:** `ProductController@getResource`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Product ID" } }, { "name": "Update Product", "request": { "method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Product Name\",\n \"price\": 99.99\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/product-update/{{product_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "product-update", "{{product_id}}"] }, "description": "**Purpose:** Update product (configurable)\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/products/edit/{id}`\n- **Component:** ProductForm\n- **Trigger:** Save button\n\n**Blade Reference:** `ProductController@update`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Product ID\n- **name** (body, string, optional): Product name\n- **price** (body, number, optional): Product price" } }, { "name": "Update Simple Product", "request": { "method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Simple Product\",\n \"price\": 49.99\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/product-update-simple/{{product_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "product-update-simple", "{{product_id}}"] }, "description": "**Purpose:** Update simple product\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/products/edit/{id}`\n- **Component:** SimpleProductForm\n- **Trigger:** Save button\n\n**Blade Reference:** `ProductController@updateSimple`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Product ID" } }, { "name": "Delete Product", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/products/{{product_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "products", "{{product_id}}"] }, "description": "**Purpose:** Delete product\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/products`\n- **Component:** ProductList\n- **Trigger:** Delete button\n\n**Blade Reference:** `ProductController@destroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Product ID" } }, { "name": "Search Products", "request": { "method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"search_key\": \"product name\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/product-search", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "product-search"] }, "description": "**Purpose:** Search products\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/products`\n- **Component:** ProductSearch\n- **Trigger:** Search input\n\n**Blade Reference:** `ProductController@searchProduct`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **search_key** (body, string, required): Search term" } } ] }, { "name": "Categories", "description": "# Categories\n\nManage product categories", "item": [ { "name": "List Categories", "request": { "method": "GET", "header": [{"key": "Accept", "value": "application/json"}], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/categories", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "categories"] }, "description": "**Purpose:** Get all categories\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/categories`\n- **Component:** CategoryList\n- **Trigger:** Page load\n\n**Blade Reference:** `CategoryController@allResources`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:** None" } }, { "name": "Create Category", "request": { "method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"name\": \"New Category\",\n \"slug\": \"new-category\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/categories", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "categories"] }, "description": "**Purpose:** Create new category\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/categories/create`\n- **Component:** CategoryForm\n- **Trigger:** Save button\n\n**Blade Reference:** `CategoryController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **name** (body, string, required): Category name\n- **slug** (body, string, required): Category slug" } }, { "name": "Get Category", "request": { "method": "GET", "header": [{"key": "Accept", "value": "application/json"}], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/categories/{{category_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "categories", "{{category_id}}"] }, "description": "**Purpose:** Get category details\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/categories/edit/{id}`\n- **Component:** CategoryEdit\n- **Trigger:** Page load\n\n**Blade Reference:** `CategoryController@getResource`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Category ID" } }, { "name": "Update Category", "request": { "method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Category\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/categories/{{category_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "categories", "{{category_id}}"] }, "description": "**Purpose:** Update category\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/categories/edit/{id}`\n- **Component:** CategoryForm\n- **Trigger:** Save button\n\n**Blade Reference:** `CategoryController@update`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Category ID" } }, { "name": "Delete Category", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/categories/{{category_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "categories", "{{category_id}}"] }, "description": "**Purpose:** Delete category\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/categories`\n- **Component:** CategoryList\n- **Trigger:** Delete button\n\n**Blade Reference:** `CategoryController@destroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Category ID" } } ] }, { "name": "Attributes", "description": "# Attributes\n\nManage product attributes", "item": [ { "name": "List Attributes", "request": { "method": "GET", "header": [{"key": "Accept", "value": "application/json"}], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attributes", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attributes"] }, "description": "**Purpose:** Get all attributes\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/attributes`\n- **Component:** AttributeList\n- **Trigger:** Page load\n\n**Blade Reference:** `AttributeController@allResources`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:** None" } }, { "name": "Create Attribute", "request": { "method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"code\": \"color\",\n \"type\": \"select\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attributes", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attributes"] }, "description": "**Purpose:** Create new attribute\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/attributes/create`\n- **Component:** AttributeForm\n- **Trigger:** Save button\n\n**Blade Reference:** `AttributeController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **code** (body, string, required): Attribute code\n- **type** (body, string, required): Attribute type" } }, { "name": "Get Attribute", "request": { "method": "GET", "header": [{"key": "Accept", "value": "application/json"}], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attributes/{{attribute_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attributes", "{{attribute_id}}"] }, "description": "**Purpose:** Get attribute details\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/attributes/edit/{id}`\n- **Component:** AttributeEdit\n- **Trigger:** Page load\n\n**Blade Reference:** `AttributeController@getResource`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Attribute ID" } }, { "name": "Update Attribute", "request": { "method": "PUT", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"admin_name\": \"Updated Attribute\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attributes/{{attribute_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attributes", "{{attribute_id}}"] }, "description": "**Purpose:** Update attribute\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/attributes/edit/{id}`\n- **Component:** AttributeForm\n- **Trigger:** Save button\n\n**Blade Reference:** `AttributeController@update`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Attribute ID" } }, { "name": "Delete Attribute", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attributes/{{attribute_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attributes", "{{attribute_id}}"] }, "description": "**Purpose:** Delete attribute\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/attributes`\n- **Component:** AttributeList\n- **Trigger:** Delete button\n\n**Blade Reference:** `AttributeController@destroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Attribute ID" } } ] }, { "name": "Attribute Families", "description": "# Attribute Families\n\nManage attribute families", "item": [ { "name": "List Attribute Families", "request": { "method": "GET", "header": [{"key": "Accept", "value": "application/json"}], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attribute-families", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attribute-families"] }, "description": "**Purpose:** Get all attribute families\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/families`\n- **Component:** FamilyList\n- **Trigger:** Page load\n\n**Blade Reference:** `AttributeFamilyController@allResources`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:** None" } }, { "name": "Create Attribute Family", "request": { "method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"code\": \"default\",\n \"name\": \"Default\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attribute-families", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attribute-families"] }, "description": "**Purpose:** Create new attribute family\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/families/create`\n- **Component:** FamilyForm\n- **Trigger:** Save button\n\n**Blade Reference:** `AttributeFamilyController@store`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **code** (body, string, required): Family code\n- **name** (body, string, required): Family name" } }, { "name": "Get Attribute Family", "request": { "method": "GET", "header": [{"key": "Accept", "value": "application/json"}], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attribute-families/{{attribute_family_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attribute-families", "{{attribute_family_id}}"] }, "description": "**Purpose:** Get attribute family details\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/families/edit/{id}`\n- **Component:** FamilyEdit\n- **Trigger:** Page load\n\n**Blade Reference:** `AttributeFamilyController@getResource`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Attribute family ID" } }, { "name": "Update Attribute Family", "request": { "method": "PUT", "header": [{"key": "Content-Type", "value": "application/json"}], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Family\"\n}" }, "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attribute-families/{{attribute_family_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attribute-families", "{{attribute_family_id}}"] }, "description": "**Purpose:** Update attribute family\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/families/edit/{id}`\n- **Component:** FamilyForm\n- **Trigger:** Save button\n\n**Blade Reference:** `AttributeFamilyController@update`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Attribute family ID" } }, { "name": "Delete Attribute Family", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/admin/catalog/attribute-families/{{attribute_family_id}}", "host": ["{{base_url}}"], "path": ["api", "v1", "admin", "catalog", "attribute-families", "{{attribute_family_id}}"] }, "description": "**Purpose:** Delete attribute family\n\n**Frontend Usage:**\n- **Page:** `/admin/catalog/families`\n- **Component:** FamilyList\n- **Trigger:** Delete button\n\n**Blade Reference:** `AttributeFamilyController@destroy`\n\n**Authentication:** Sanctum bearer token, admin role required\n\n**Request Parameters:**\n- **id** (path, integer, required): Attribute family ID" } } ] } ] } ] }