WebSVN – SmartDukaan – Diff – /trunk/profitmandi-web/src/main/resources/external-api-docs.html

   <code>/categoryMaster</code>). Every feed and lookup only ever returns catalogs, SKUs and stock within
   those categories. <code>title</code> is present and non-empty on catalog, SKU and stock records — the
   same derived product title everywhere.
 </div>
+<h2>Parameters at a glance</h2>
+<table>
+  <tr><th>Endpoint</th><th>Required</th><th>Optional (default)</th></tr>
+  <tr><td><code>/categoryMaster</code></td><td>—</td><td>—</td></tr>
+  <tr><td><code>/catalogMaster</code></td><td>—</td><td><code>offset</code> (0), <code>limit</code> (100, max 100), <code>updatedSince</code></td></tr>
+  <tr><td><code>/catalogSkuMaster</code></td><td>—</td><td><code>offset</code> (0), <code>limit</code> (100, max 500), <code>updatedSince</code></td></tr>
+  <tr><td><code>/skuMaster</code></td><td>—</td><td><code>offset</code> (0), <code>limit</code> (100, max 500), <code>updatedSince</code>, <code>storeId</code></td></tr>
+  <tr><td><code>/storeMaster</code></td><td>—</td><td><code>offset</code> (0), <code>limit</code> (100, max 500)</td></tr>
+  <tr><td><code>/stock</code></td><td><code>storeId</code></td><td><code>itemIds</code> (≤100 ids); without it: <code>offset</code> (0), <code>limit</code> (100, max 500)</td></tr>
+  <tr><td><code>/catalogs</code></td><td><code>catalogIds</code> (≤50 ids)</td><td>—</td></tr>
+  <tr><td><code>/catalogSkus</code></td><td><code>catalogIds</code> (≤50 ids)</td><td>—</td></tr>
+</table>
+<p>Every optional parameter can simply be omitted. <code>updatedSince</code> is epoch
+<strong>milliseconds</strong>; omit it for a full sync. <code>limit</code> above its maximum is
+silently clamped; <code>limit</code> ≤ 0 falls back to the default.</p>
 <h2>Master feeds (paginated sync)</h2>
 <h3><span class="method">GET</span>/categoryMaster</h3>
 <p>The categories your key may access, each with its spec schema (the keys you will find in
-<code>categorySpecs</code> on catalog content). Full list, no pagination.</p>
+<code>categorySpecs</code> on catalog content). Full list, no pagination, no parameters.</p>
 <pre>GET /external/v1/categoryMaster
 → [ { "categoryId": 10006, "label": "Mobile", "displayName": "Mobile Phones",
       "specs": [ { "key": "ram", "label": "RAM", "position": 1 },
                  { "key": "memory", "label": "Internal Storage", "position": 2 } ] } ]</pre>
-<p>All feeds accept <code>offset</code> (default 0), <code>limit</code>, and optional
+<p>All other feeds accept optional <code>offset</code>, <code>limit</code> and
-<code>updatedSince</code> (epoch ms) and return:</p>
+<code>updatedSince</code> (see table above) and return:</p>
 <pre>{
   "serverTime": 1753600000000,   // pass back as next updatedSince
   "offset": 0, "limit": 100,
   "totalCount": 5321,
   "records": [ ... ]
                "mop": 14999.0, "mrp": 17999.0, "active": true,
                "updatedAt": 1753500000000, "addedOn": 1750000000000 } ]</pre>
 <h3><span class="method">GET</span>/skuMaster</h3>
 <p>Per-store stock + price rows for <em>your mapped stores</em>, with full item identity on every row.
-<code>limit</code> max 500. Optional <code>storeId</code> narrows to one store (must be mapped to you).</p>
+<code>limit</code> max 500. Optional <code>storeId</code> narrows to one store (must be mapped to you;
+an unmapped id → 403 <code>EXT_403</code>). Omitting <code>storeId</code> returns rows across all your
+mapped stores.</p>
 <pre>GET /external/v1/skuMaster?offset=0&amp;limit=500
 → records: [ { "storeId": 2116665, "itemId": 101, "title": "Samsung Galaxy A15 SM-A155F",
                "brand": "Samsung", "modelName": "Galaxy A15", "modelNumber": "SM-A155F",
                "color": "Blue", "brandIdentifier": "SM-A155FZKW", "availability": 7,
                "mop": 14999.0, "mrp": 17999.0, "active": true, "updatedAt": 1753500000000 } ]</pre>
 </div>
 <h2>Real-time lookups</h2>
 <h3><span class="method">GET</span>/stock</h3>
-<p>Live stock + price in one mapped store, with item identity on every row. Two modes:</p>
+<p>Live stock + price in one mapped store, with item identity on every row. <code>storeId</code> is
+required; <code>itemIds</code> is optional and selects the mode:</p>
 <ul>
   <li><strong>By ids</strong> — pass <code>itemIds</code> (up to 100). Every requested <code>itemId</code> is
       returned; no stock row means <code>availability: 0</code>, no active listing means
       <code>mop/mrp: null</code>. Ids outside your categories come back as id-only rows with
-      <code>availability: 0</code>.</li>
+      <code>availability: 0</code>. <code>offset</code>/<code>limit</code> are ignored in this mode.</li>
   <li><strong>Full store</strong> — omit <code>itemIds</code> to page through the store's entire stock with
-      <code>offset</code>/<code>limit</code> (max 500); the response is the standard paginated envelope
+      optional <code>offset</code> (default 0) / <code>limit</code> (default 100, max 500); the response is
-      (<code>serverTime</code>/<code>totalCount</code>/<code>records</code>). One loop replaces batching ids
+      the standard paginated envelope (<code>serverTime</code>/<code>totalCount</code>/<code>records</code>).
-      across many calls.</li>
+      One loop replaces batching ids across many calls.</li>
 </ul>
 <pre>GET /external/v1/stock?storeId=2116665&amp;itemIds=101,102
 → [ { "storeId": 2116665, "itemId": 101, "title": "Samsung Galaxy A15 SM-A155F",
       "brand": "Samsung", "modelName": "Galaxy A15", "modelNumber": "SM-A155F", "color": "Blue",
       "brandIdentifier": "SM-A155FZKW", "availability": 7, "mop": 14999.0, "mrp": 17999.0, "active": true },

Subversion Repositories SmartDukaan

(root)/trunk/profitmandi-web/src/main/resources/external-api-docs.html – Rev 37280 → 37291