{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/asianpaints.binaryic.in\/" } ], "info": { "name": "Laravel API Documentation", "_postman_id": "b893dd00-b9bf-435d-81a3-0b9821b6e3d3", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Account Management", "description": "", "item": [ { "name": "Get Account Statement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/account-statement", "query": [], "raw": "{{baseUrl}}\/api\/account-statement" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"kunnr\":\"0001001234\",\"start_date\":\"2023-01-01\",\"end_date\":\"2023-12-31\"}" }, "description": "Fetch the account statement for a specific customer (kunnr) within an optional date range.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Account statement fetched successfully\",\n \"data\": {\n \"openingBal\": \"1500.50\",\n \"details\": [\n {\n \"docDate\": \"2023-05-10\",\n \"docNo\": \"1800001234\",\n \"docDesc\": \"Invoice Payment\",\n \"docAmount\": \"500.00\",\n \"balAmount\": \"1000.00\"\n }\n ],\n \"itCollection\": [],\n \"itInvoices\": []\n }\n}", "name": "" } ] }, { "name": "Standardized PDF Generation and Retrieval (acstn).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/account-statement-pdf", "query": [], "raw": "{{baseUrl}}\/api\/account-statement-pdf" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer\":\"AER10558\",\"startDate\":\"2024-01-01\",\"endDate\":\"2026-07-08\"}" }, "description": "Generate and retrieve a URL for the account statement PDF for a specific customer within an optional date range.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"PDF generated successfully\",\n \"data\": {\n \"pdf_url\": \"https:\/\/asianpaints-staging.binaryic.in\/storage\/statements\/account_statement_AER10558_1775541059.pdf\",\n \"filename\": \"account_statement_AER10558_1775541059.pdf\"\n }\n}", "name": "" } ] } ] }, { "name": "Authentication", "description": "", "item": [ { "name": "Send OTP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/send-otp", "query": [], "raw": "{{baseUrl}}\/api\/send-otp" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mobile\":\"0771234567\"}" }, "description": "Generates and sends a 4-digit OTP to the provided mobile number via Dialog SMS gateway.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"OTP sent successfully\",\n \"data\": {\n \"status\": \"success\",\n \"message\": \"OTP sent successfully\"\n }\n}", "name": "" } ] }, { "name": "Verify OTP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/verify-otp", "query": [], "raw": "{{baseUrl}}\/api\/verify-otp" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mobile\":\"0771234567\",\"otp\":\"1234\"}" }, "description": "Verifies the 4-digit OTP sent to the user's mobile number.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"OTP verified successfully\",\n \"data\": {\n \"status\": \"success\",\n \"message\": \"OTP verified successfully\"\n }\n}", "name": "" } ] } ] }, { "name": "Cart Management", "description": "", "item": [ { "name": "Retrieve the final price for a set of materials.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/check-final-price", "query": [], "raw": "{{baseUrl}}\/api\/check-final-price" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer\":\"AER10558\",\"stpCustomer\":\"AER10558\",\"docTyp\":\"ZIRO\",\"mat\":[{\"matnr\":\"AE1-F0006099918T\",\"kwmeng\":\"10.000\"}]}" }, "description": "Delegates the CPI POST call to CartService, evaluates the result,\nand returns a standard JSON envelope. On downstream failure, returns\na structured 200 error response without exposing upstream details.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Final price fetched successfully\",\n \"data\": {\n \"ltOut\": [\n {\n \"material\": \"AE1-F0006099918T\",\n \"netValue\": \"45670.0000\",\n \"discount\": \"-10960.80\",\n \"tax\": \"1735.46\",\n \"grossValue\": \"36444.66\",\n \"currency\": \"AED\"\n },\n {\n \"material\": \"AE1-F05730997025\",\n \"netValue\": \"1840.0000\",\n \"discount\": \"-441.60\",\n \"tax\": \"69.92\",\n \"grossValue\": \"1468.32\",\n \"currency\": \"AED\"\n }\n ],\n \"pdfString\": \"\",\n \"mat\": [\n {\n \"matnr\": \"AE1-F0006099918T\",\n \"kwmeng\": \"10.000\"\n },\n {\n \"matnr\": \"AE1-F05730997025\",\n \"kwmeng\": \"10.000\"\n }\n ],\n \"return\": []\n }\n}", "name": "" } ] }, { "name": "Retrieve payment terms for a given dealer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/get-payment-terms", "query": [], "raw": "{{baseUrl}}\/api\/get-payment-terms" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer\":\"AER10558\"}" }, "description": "Delegates the CPI call to CartService::getPaymentTerms, extracts unique\npayTerm values from the `knavvv` array in the response body, and returns\na standard JSON envelope. On downstream failure, returns a structured\n200 error response without exposing upstream details.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Dealer payment terms fetched successfully\",\n \"data\": {\n \"customer\": \"AER10558\",\n \"payTerms\": [\n \"P180\"\n ]\n }\n}", "name": "" } ] }, { "name": "Retrieve the ship-to-party list for a given dealer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/get-ship-to-party-list", "query": [], "raw": "{{baseUrl}}\/api\/get-ship-to-party-list" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"vkorg\":\"AE10\",\"vtweg\":\"10\",\"spart\":\"01\",\"kunnr\":\"AER10558\"}" }, "description": "Delegates the CPI POST call to CartService::getSTPList, evaluates the\nresult, and returns a standard JSON envelope. On downstream failure,\nreturns a structured 200 error response without exposing upstream details.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Ship to party fetched successfully\",\n \"data\": [\n {\n \"stpRes\": [\n {\n \"shipToParty\": \"AER10558\",\n \"shipToPartyName\": \"EXTRACO FIBER GLASS & PREFAB\"\n }\n ],\n \"Message\": []\n }\n ]\n}", "name": "" } ] }, { "name": "Retrieve FOC (Free of Charge) products for a given order.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/get-foc-products", "query": [], "raw": "{{baseUrl}}\/api\/get-foc-products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"order\":[{\"matnr\":\"AE1-F0006099918T\",\"kwmeng\":\"1.000\",\"vkaus\":\"\\\"\\\"\"}]}" }, "description": "Delegates the CPI POST call to CartService::getFOCProducts, evaluates the\nresult, and returns a standard JSON envelope. On downstream failure,\nreturns a structured 200 error response without exposing upstream details.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"FOC products fetched successfully\",\n \"data\": {\n \"itProdVol\": [\n {\n \"prodCode\": \"AE1-F0006\",\n \"prodDesc\": \" MANSONARY PRIMER\",\n \"totalQty\": \"1.000\",\n \"totalVol\": \"18.000\"\n },\n {\n \"prodCode\": \"AE1-F0106\",\n \"prodDesc\": \"ROYALE PLAY ITALIAN STUCCO.\",\n \"totalQty\": \"10.000\",\n \"totalVol\": \"140.000\"\n }\n ],\n \"itZforMatnrs1\": [\n {\n \"material\": \"AE1-F0106H27914K\",\n \"materialDesc\": \"R\/P ITALIAN STUCCO CW L152\",\n \"salesNo\": \"\",\n \"agreementDesc\": \"In-bill Qty FOC \u2013 09\",\n \"freeMaterial\": \"AE1-F00040000098df6\"\n },\n {\n \"material\": \"AE1-F00040000180\",\n \"materialDesc\": \"SUPREME PVA PRIMER WHITE\",\n \"salesNo\": \"\",\n \"agreementDesc\": \"In-bill Qty FOC \u2013 09\",\n \"freeMaterial\": \"AE1-F0006099918T\"\n }\n ],\n \"Return\": []\n }\n}", "name": "" } ] } ] }, { "name": "Dashboard Integration", "description": "", "item": [ { "name": "Get Integrated Customer Dashboard", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dashboard-api", "query": [], "raw": "{{baseUrl}}\/api\/dashboard-api" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer\":\"AER10558\"}" }, "description": "Fetch financial performance and account statement data for the specified customer.\nThis API integrates with the SAP ODOS endpoint and automatically processes embedded PDF statements.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Dashboard data retrieved successfully\",\n \"data\": {\n \"tab\": [...],\n \"pdf_url\": \"https:\/\/asianpaints.dev\/storage\/statements\/dashboard_statement_AER10558_1775541059.pdf\",\n \"filename\": \"dashboard_statement_AER10558_1775541059.pdf\"\n }\n}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "Fetch a new SAP token and persist it.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sap\/token\/refresh", "query": [], "raw": "{{baseUrl}}\/api\/sap\/token\/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Inventory", "description": "", "item": [ { "name": "Check Material Stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stock-check", "query": [], "raw": "{{baseUrl}}\/api\/stock-check" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"matnr\":\"AE1-F0122K55325K\",\"quantity\":100,\"dealer_code\":\"AER10057\"}" }, "description": "Verifies the availability of a specific material (matnr) for the requested quantity.\nReturns whether the material is fully available, partially available, or not available.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Stock fetched successfully\",\n \"data\": {\n \"matnr\": \"AE1-F0122K55325K\",\n \"requested_qty\": 100,\n \"available_qty\": 1086,\n \"api_message\": \"Available\",\n \"status\": \"available\"\n }\n}", "name": "Available" }, { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Stock fetched successfully\",\n \"data\": {\n \"matnr\": \"AE1-F0122K55325K\",\n \"requested_qty\": 100000,\n \"available_qty\": 1086,\n \"api_message\": \"Partially Available\",\n \"status\": \"partially available\"\n }\n}", "name": "Partially Available" }, { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Stock fetched successfully\",\n \"data\": {\n \"matnr\": \"AE1-F0122K55325K 000\",\n \"requested_qty\": 100000,\n \"available_qty\": 0,\n \"api_message\": \"AE1-F0122K55325K 000Entered material not available\",\n \"status\": \"not available\"\n }\n}", "name": "Not Available" } ] } ] }, { "name": "Order Management", "description": "", "item": [ { "name": "Retrieve Order List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/order-list", "query": [], "raw": "{{baseUrl}}\/api\/order-list" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"dealerCode\":\"AER10558\",\"dateFrom\":\"architecto\",\"dateTo\":\"architecto\",\"orderNo\":\"5101631911\",\"invoiceNo\":\"architecto\",\"dashboardFlag\":\"architecto\"}" }, "description": "Fetch the list of orders for a specific dealer, optionally filtered by date range or order\/invoice numbers.\nThis endpoint returns only the order-related parameters and excludes invoice details.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Order details fetched successfully\",\n \"data\": {\n \"orderList\": [\n {\n \"orderNo\": \"5101631911\",\n \"orderDate\": \"2026-02-09\",\n \"customerRef\": \"1234568\",\n \"customerRefDate\": \"0000-00-00\",\n \"orderValue\": \"3470.92\",\n \"orderedQty\": \"1.000\",\n \"billedQty\": \"1.000\",\n \"soldToAddress\": \"EXTRACO FIBER GLASS & PREFAB\",\n \"shipToAddress\": \"EXTRACO FIBER GLASS & PREFAB\",\n \"placedBy\": \"CC Agent \/ CFA\",\n \"paymentTerm\": \"180 days credit\",\n \"billingStatus\": \"Completely billed\",\n \"orderStatus\": \"In Process\",\n \"salesOrg\": \"\",\n \"channel\": \"\",\n \"division\": \"\"\n }\n ],\n \"orderItems\": [\n {\n \"orderNumber\": \"5101631911\",\n \"skuDescription\": \" MANSONARY PRIMER CLR\",\n \"totalOrderedQty\": \"1.000\",\n \"totalBilledQty\": \"1.000\"\n }\n ],\n \"headerDetails\": [\n {\n \"totalOrders\": \"0\",\n \"openOrders\": \" 388\"\n }\n ],\n \"itEpod\": [],\n \"return\": []\n }\n}", "name": "" } ] }, { "name": "Retrieve Order Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/order-details", "query": [], "raw": "{{baseUrl}}\/api\/order-details" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"dealerCode\":\"AER10558\",\"orderNo\":\"5101632649\",\"invoiceNo\":\"architecto\",\"dashboardFlag\":\"architecto\"}" }, "description": "Fetch the full breakdown for a specific order number, including invoice details,\norder items, header summary, ePOD data, and return entries.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"Order details fetched successfully\",\n \"data\": {\n \"orderList\": [...],\n \"orderItems\": [...],\n \"invoiceList\": [...],\n \"headerDetails\": [...],\n \"itEpod\": [],\n \"return\": []\n }\n}", "name": "" } ] } ] }, { "name": "Profile", "description": "", "item": [ { "name": "Get User Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/profile\/user-details", "query": [], "raw": "{{baseUrl}}\/api\/profile\/user-details" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer\":\"AER10057\"}" }, "description": "Fetch standardized user profile and loyalty details from Shopify via SAP CPI.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"User profile retrieved successfully.\",\n \"data\": {\n \"kunnr\": \"AER10057\",\n \"name1\": \"GOLDEN PALM PAINTS TRADING 123\",\n \"telf1\": \"25553383\",\n \"vkbur\": \"AE1A\",\n \"zterm\": \"P125 125 days credit\",\n \"vwerk\": \"AE1C\",\n \"adrnr\": \"\",\n \"salesOrg\": \"AE10\",\n \"distChan\": \"10\",\n \"division\": \"01\",\n \"knavvv\": [\n {\n \"customer\": \"AER10057\",\n \"salesOrg\": \"AE10\",\n \"distChan\": \"10\",\n \"division\": \"02\",\n \"payTerm\": \"P125\",\n \"plant\": \"AE1A\",\n \"salesOff\": \"AE1C\"\n }\n ],\n \"Message\": []\n }\n}", "name": "" } ] } ] }, { "name": "TSE Management", "description": "", "item": [ { "name": "Get TSE Level Dealers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tse-level-dealers", "query": [], "raw": "{{baseUrl}}\/api\/tse-level-dealers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bukrs\":\"IAE1\",\"mobileNumber\":\"917441104130\",\"customer_code\":\"AED10063\"}" }, "description": "Fetch TSE level dealers for the given company code and mobile number.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status_code\": 200,\n \"message\": \"TSE level dealers fetched successfully\",\n \"data\": {\n \"Return\": [],\n \"Knvh\": [\n {\n \"kunnr\": \"AER11076\",\n \"name1\": \"BYBLOS BUILDING MATERIALS TRAD\",\n \"ort01\": \" 07-2442196\",\n \"counc\": \"999\",\n \"bezei\": \"Dummy\",\n \"hkunnr\": \"00IAE1C102\"\n },\n {\n \"kunnr\": \"AER11173\",\n \"name1\": \"AL AZEM BUILDING MAT\",\n \"ort01\": \"AE\",\n \"counc\": \"999\",\n \"bezei\": \"Dummy\",\n \"hkunnr\": \"00IAE1C102\"\n }\n ],\n \"pdf\": \"JVBERi0xLjYNJeLjz9MNCjI1MTggMCBvYmoKPDwvRmlsd...\"\n }\n}", "name": "" } ] } ] } ], "auth": { "type": "noauth" } }