@boostengine/collections 1.0.0

package/README.md

@@ -0,0 +1,111 @@
+# @boostengine/collections
+
+> Production-ready **Postman Collections (v2.1.0)** and **Environment Templates** for Indian eCommerce APIs: **Razorpay Payment Gateway** and **EasyEcom WMS & ERP**.
+
+Includes a zero-install **CLI tool** (`npx @boostengine/collections export`) to dump ready-to-import Postman JSON files into any project in 1 second.
+
+---
+
+## ⚡ Quickstart (CLI)
+
+Export complete collections and environment variables into your current working directory without installing:
+
+```bash
+# Export all collections & environments
+npx @boostengine/collections export all
+
+# Or export individually:
+npx @boostengine/collections export razorpay
+npx @boostengine/collections export easyecom
+
+# Inspect available endpoints inside terminal:
+npx @boostengine/collections info razorpay
+```
+
+### 📥 How to Import into Postman / Bruno / Insomnia:
+1. Open **Postman** (or Insomnia / Bruno / ThunderClient).
+2. Click **Import** (Top left).
+3. Drag & drop the exported `*.collection.json` and `*.env.json` files.
+4. Select the imported Environment from top-right dropdown, paste your API keys, and start sending requests!
+
+---
+
+## 📦 What's Included
+
+### 1. 💳 Razorpay eCommerce API Collection (`razorpay.collection.json`)
+Official REST APIs configured with Basic Authentication:
+* **Orders API**:
+  - `POST /v1/orders` (Create order with amount, currency, notes, receipt)
+  - `GET /v1/orders/:id` (Fetch order details)
+  - `GET /v1/orders/:id/payments` (Fetch all payments attempted against order)
+  - `GET /v1/orders` (List recent orders with pagination)
+* **Payments API**:
+  - `GET /v1/payments/:id` (Fetch payment status, UPI VPA, card details)
+  - `POST /v1/payments/:id/capture` (Manual payment capture)
+  - `PATCH /v1/payments/:id` (Update custom payment notes)
+* **Refunds API**:
+  - `POST /v1/payments/:id/refund` (Instant & normal customer refunds)
+  - `GET /v1/refunds/:id` (Check refund status)
+  - `GET /v1/refunds` (List recent refunds)
+* **Webhook Simulator**:
+  - `order.paid` mock payload
+  - `payment.failed` mock payload
+  - `payment.captured` mock payload
+  - `refund.processed` mock payload
+  - HMAC SHA256 signature verification guidance
+
+---
+
+### 2. 🏬 EasyEcom Warehouse & ERP Collection (`easyecom.collection.json`)
+Official REST APIs configured with Bearer Token Authentication:
+* **Orders API**:
+  - `GET /orders/v2/getOrders` (Fetch pending & unfulfilled orders)
+  - `POST /orders/v2/createOrder` (Push new storefront orders into ERP)
+  - `POST /orders/v2/updateOrderStatus` (Update fulfillment status to Shipped/Delivered)
+  - `POST /orders/v2/cancelOrder` (Cancel order and auto-restore warehouse inventory)
+* **Inventory & Multi-Warehouse Stock**:
+  - `GET /inventory/v2/getInventoryDetails` (Check sellable stock by SKU)
+  - `POST /inventory/v2/updateInventory` (Sync warehouse inventory count)
+  - `GET /inventory/v2/getWarehouses` (List all active fulfillment centers)
+* **Master Catalog**:
+  - `GET /catalog/v2/getMasterProducts` (Fetch product master records)
+  - `POST /catalog/v2/createProduct` (Register master SKU with HSN code & dimensions)
+* **Shipping & Manifests**:
+  - `POST /shipping/v2/generateAwb` (Generate shipping label & tracking number)
+  - `POST /shipping/v2/createManifest` (Create courier handover manifest PDF)
+
+---
+
+## 💻 Programmatic Node.js / TypeScript Usage
+
+You can also install this package as a dev dependency to programmatically parse or mock endpoints in your backend tests:
+
+```bash
+npm install -D @boostengine/collections
+```
+
+```typescript
+import {
+  razorpayCollection,
+  easyecomCollection,
+  listCollections,
+  getCollection,
+  exportToDirectory,
+} from '@boostengine/collections';
+
+// List available collection summaries
+const available = listCollections();
+console.log(available);
+
+// Access raw Postman Schema v2.1.0 JSON object
+console.log(razorpayCollection.info.name);
+console.log(easyecomCollection.item.length);
+
+// Programmatically dump files in CI/CD or setup scripts
+exportToDirectory('all', './postman');
+```
+
+---
+
+## 📄 License
+MIT © [Boost Engine](https://github.com/boostengine)

package/bin/cli.cjs

@@ -0,0 +1,115 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const collectionsDir = path.join(__dirname, '..', 'collections');
+const envsDir = path.join(__dirname, '..', 'environments');
+
+const collections = {
+  razorpay: {
+    name: 'Razorpay eCommerce API Collection',
+    collectionFile: path.join(collectionsDir, 'razorpay.collection.json'),
+    envFile: path.join(envsDir, 'razorpay.env.json'),
+    docs: 'https://razorpay.com/docs/api',
+    description: 'Orders, Payments, Refunds & Webhook Simulator',
+  },
+  easyecom: {
+    name: 'EasyEcom eCommerce & Warehouse API Collection',
+    collectionFile: path.join(collectionsDir, 'easyecom.collection.json'),
+    envFile: path.join(envsDir, 'easyecom.env.json'),
+    docs: 'https://api.easyecom.com/documentation',
+    description: 'Orders, Multi-Warehouse Inventory, Catalog & Shipping Manifests',
+  },
+};
+
+const args = process.argv.slice(2);
+const command = args[0] || 'help';
+
+console.log('\n📦 \x1b[1m\x1b[34m@boostengine/collections\x1b[0m - Indian eCommerce Postman Collections CLI\n');
+
+switch (command) {
+  case 'list': {
+    console.log('Available Production-Ready Collections:\n');
+    Object.keys(collections).forEach((key) => {
+      const item = collections[key];
+      console.log(`  \x1b[32m● ${key}\x1b[0m - \x1b[1m${item.name}\x1b[0m`);
+      console.log(`    Description: ${item.description}`);
+      console.log(`    Docs:        \x1b[36m${item.docs}\x1b[0m\n`);
+    });
+    console.log('💡 Run: \x1b[33mnpx @boostengine/collections export <name>\x1b[0m to dump JSON files.\n');
+    break;
+  }
+
+  case 'export': {
+    const target = (args[1] || 'all').toLowerCase();
+    const destDir = args[2] ? path.resolve(process.cwd(), args[2]) : process.cwd();
+
+    if (!fs.existsSync(destDir)) {
+      fs.mkdirSync(destDir, { recursive: true });
+    }
+
+    const exportKeys = target === 'all' ? Object.keys(collections) : [target];
+
+    if (!collections[target] && target !== 'all') {
+      console.error(`\x1b[31m❌ Unknown collection "${target}".\x1b[0m`);
+      console.log(`Available: ${Object.keys(collections).join(', ')} or "all"\n`);
+      process.exit(1);
+    }
+
+    console.log(`🚀 Exporting collections to: \x1b[36m${destDir}\x1b[0m\n`);
+
+    exportKeys.forEach((key) => {
+      const item = collections[key];
+      const colDest = path.join(destDir, `${key}.collection.json`);
+      const envDest = path.join(destDir, `${key}.env.json`);
+
+      fs.copyFileSync(item.collectionFile, colDest);
+      fs.copyFileSync(item.envFile, envDest);
+
+      console.log(`  ✅ \x1b[32m${key}\x1b[0m:`);
+      console.log(`     ├── Collection: \x1b[33m${path.basename(colDest)}\x1b[0m`);
+      console.log(`     └── Environment: \x1b[33m${path.basename(envDest)}\x1b[0m`);
+    });
+
+    console.log('\n✨ Export complete! How to import into Postman:');
+    console.log('  1. Open Postman / Insomnia / Bruno.');
+    console.log('  2. Click "Import" and select the generated *.collection.json and *.env.json files.');
+    console.log('  3. Set your API credentials in the Environment variables & start testing!\n');
+    break;
+  }
+
+  case 'info': {
+    const target = (args[1] || '').toLowerCase();
+    if (!collections[target]) {
+      console.error(`\x1b[31m❌ Please specify a valid collection: ${Object.keys(collections).join(', ')}\x1b[0m\n`);
+      process.exit(1);
+    }
+    const item = collections[target];
+    const colJson = JSON.parse(fs.readFileSync(item.collectionFile, 'utf8'));
+
+    console.log(`\x1b[1mCollection:\x1b[0m   ${item.name}`);
+    console.log(`\x1b[1mDocs:\x1b[0m         ${item.docs}`);
+    console.log(`\x1b[1mFolders:\x1b[0m`);
+    colJson.item.forEach((f) => {
+      console.log(`  📁 ${f.name} (${f.item ? f.item.length : 0} requests)`);
+      if (f.item) {
+        f.item.forEach((req) => {
+          const method = req.request?.method || 'GET';
+          console.log(`     • [${method}] ${req.name}`);
+        });
+      }
+    });
+    console.log('');
+    break;
+  }
+
+  default: {
+    console.log('Commands:');
+    console.log('  \x1b[33mnpx @boostengine/collections list\x1b[0m                  List all available API collections');
+    console.log('  \x1b[33mnpx @boostengine/collections export <name>\x1b[0m        Export collection (razorpay, easyecom, all)');
+    console.log('  \x1b[33mnpx @boostengine/collections export <name> <dir>\x1b[0m  Export into custom directory');
+    console.log('  \x1b[33mnpx @boostengine/collections info <name>\x1b[0m          Inspect folders and endpoints in collection\n');
+    break;
+  }
+}

package/collections/easyecom.collection.json

@@ -0,0 +1,276 @@
+{
+  "info": {
+    "_postman_id": "8f21bc90-2134-4b45-9128-b12a83e01290",
+    "name": "EasyEcom eCommerce & Warehouse API Collection",
+    "description": "Production-ready Postman Collection for EasyEcom Inventory, Orders, Multi-Warehouse Stock, and Courier Manifest APIs. Maintained by Boost Engine (@boostengine/collections).",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+  },
+  "auth": {
+    "type": "bearer",
+    "bearer": [
+      {
+        "key": "token",
+        "value": "{{easyecom_api_token}}",
+        "type": "string"
+      }
+    ]
+  },
+  "item": [
+    {
+      "name": "Orders",
+      "description": "APIs to push new storefront orders, fetch pending orders, and manage fulfillment status in EasyEcom.",
+      "item": [
+        {
+          "name": "1. Fetch Pending Orders",
+          "request": {
+            "method": "GET",
+            "header": [],
+            "url": {
+              "raw": "{{easyecom_base_url}}/orders/v2/getOrders?status=pending&limit=20",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["orders", "v2", "getOrders"],
+              "query": [
+                {
+                  "key": "status",
+                  "value": "pending"
+                },
+                {
+                  "key": "limit",
+                  "value": "20"
+                }
+              ]
+            },
+            "description": "Fetches unfulfilled / pending orders waiting for picklist and invoice generation."
+          }
+        },
+        {
+          "name": "2. Create / Push Store Order",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"order_details\": {\n    \"order_reference_id\": \"ORD_BOOST_9821\",\n    \"order_date\": \"2026-09-08 18:30:00\",\n    \"payment_mode\": \"Prepaid\",\n    \"marketplace\": \"CustomStore\",\n    \"customer_details\": {\n      \"first_name\": \"Rahul\",\n      \"last_name\": \"Verma\",\n      \"email\": \"rahul.verma@example.com\",\n      \"contact_number\": \"9876543210\"\n    },\n    \"shipping_address\": {\n      \"address_line_1\": \"Flat 402, Skyline Residency, Link Road\",\n      \"city\": \"Mumbai\",\n      \"state\": \"Maharashtra\",\n      \"pin_code\": \"400053\",\n      \"country\": \"India\"\n    },\n    \"order_items\": [\n      {\n        \"sku\": \"TEE-ANIME-BLK-L\",\n        \"item_title\": \"Oversized Anime Black T-Shirt (Large)\",\n        \"quantity\": 1,\n        \"selling_price\": 799,\n        \"tax_percentage\": 5,\n        \"discount\": 0\n      }\n    ],\n    \"total_amount\": 799,\n    \"shipping_charges\": 0\n  }\n}"
+            },
+            "url": {
+              "raw": "{{easyecom_base_url}}/orders/v2/createOrder",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["orders", "v2", "createOrder"]
+            },
+            "description": "Pushes a new order from your custom eCommerce store or mobile app into EasyEcom ERP."
+          }
+        },
+        {
+          "name": "3. Update Order Status",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"order_reference_id\": \"ORD_BOOST_9821\",\n  \"status\": \"shipped\",\n  \"tracking_number\": \"AWB_DELHIVERY_1092831\",\n  \"courier_name\": \"Delhivery Surface\"\n}"
+            },
+            "url": {
+              "raw": "{{easyecom_base_url}}/orders/v2/updateOrderStatus",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["orders", "v2", "updateOrderStatus"]
+            },
+            "description": "Updates order fulfillment status (e.g. packed, shipped, delivered, rto)."
+          }
+        },
+        {
+          "name": "4. Cancel Order",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"order_reference_id\": \"ORD_BOOST_9821\",\n  \"cancellation_reason\": \"Customer requested cancellation before dispatch\"\n}"
+            },
+            "url": {
+              "raw": "{{easyecom_base_url}}/orders/v2/cancelOrder",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["orders", "v2", "cancelOrder"]
+            },
+            "description": "Cancels an order before it is dispatched and restores inventory in EasyEcom warehouse."
+          }
+        }
+      ]
+    },
+    {
+      "name": "Inventory & Multi-Warehouse Stock",
+      "description": "APIs to query and sync live stock levels across central and regional fulfillment centers.",
+      "item": [
+        {
+          "name": "1. Get Inventory by SKU",
+          "request": {
+            "method": "GET",
+            "header": [],
+            "url": {
+              "raw": "{{easyecom_base_url}}/inventory/v2/getInventoryDetails?sku={{sku}}",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["inventory", "v2", "getInventoryDetails"],
+              "query": [
+                {
+                  "key": "sku",
+                  "value": "{{sku}}"
+                }
+              ]
+            },
+            "description": "Fetches current physical stock, allocated stock, and sellable stock for a specific SKU."
+          }
+        },
+        {
+          "name": "2. Update Warehouse Stock",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"warehouse_id\": \"{{warehouse_id}}\",\n  \"sku\": \"TEE-ANIME-BLK-L\",\n  \"quantity\": 50,\n  \"update_type\": \"absolute\",\n  \"remarks\": \"New batch inward stock from manufacturer\"\n}"
+            },
+            "url": {
+              "raw": "{{easyecom_base_url}}/inventory/v2/updateInventory",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["inventory", "v2", "updateInventory"]
+            },
+            "description": "Updates warehouse inventory. Supports update_type 'absolute' (set exact count) or 'incremental' (add/subtract)."
+          }
+        },
+        {
+          "name": "3. Get All Warehouses List",
+          "request": {
+            "method": "GET",
+            "header": [],
+            "url": {
+              "raw": "{{easyecom_base_url}}/inventory/v2/getWarehouses",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["inventory", "v2", "getWarehouses"]
+            },
+            "description": "Retrieves the list of active warehouse locations and fulfillment centers."
+          }
+        }
+      ]
+    },
+    {
+      "name": "Master Catalog & SKUs",
+      "description": "APIs to manage master product catalog, HSN codes, dimensions, and weights.",
+      "item": [
+        {
+          "name": "1. Get Master Products",
+          "request": {
+            "method": "GET",
+            "header": [],
+            "url": {
+              "raw": "{{easyecom_base_url}}/catalog/v2/getMasterProducts?limit=20&page=1",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["catalog", "v2", "getMasterProducts"],
+              "query": [
+                {
+                  "key": "limit",
+                  "value": "20"
+                },
+                {
+                  "key": "page",
+                  "value": "1"
+                }
+              ]
+            },
+            "description": "Fetches master product catalog records with weights, dimensions, and barcodes."
+          }
+        },
+        {
+          "name": "2. Create / Update Master SKU",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"sku\": \"TEE-ANIME-BLK-L\",\n  \"product_name\": \"Oversized Anime Black T-Shirt (Large)\",\n  \"brand\": \"Boost Wear\",\n  \"category\": \"Apparel\",\n  \"hsn_code\": \"61091000\",\n  \"tax_rate\": 5,\n  \"mrp\": 1499,\n  \"selling_price\": 799,\n  \"weight_in_grams\": 250,\n  \"dimensions\": {\n    \"length\": 30,\n    \"width\": 25,\n    \"height\": 3\n  }\n}"
+            },
+            "url": {
+              "raw": "{{easyecom_base_url}}/catalog/v2/createProduct",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["catalog", "v2", "createProduct"]
+            },
+            "description": "Registers or updates a master SKU with dimensions and HSN code in EasyEcom."
+          }
+        }
+      ]
+    },
+    {
+      "name": "Shipping & Manifests",
+      "description": "APIs to generate Airway Bills (AWB), shipping labels, and handover manifests.",
+      "item": [
+        {
+          "name": "1. Generate AWB / Shipping Label",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"order_reference_id\": \"ORD_BOOST_9821\",\n  \"courier_id\": \"delhivery_surface\",\n  \"pickup_warehouse_id\": \"{{warehouse_id}}\"\n}"
+            },
+            "url": {
+              "raw": "{{easyecom_base_url}}/shipping/v2/generateAwb",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["shipping", "v2", "generateAwb"]
+            },
+            "description": "Assigns courier and generates shipping label & AWB tracking number for an order."
+          }
+        },
+        {
+          "name": "2. Create Courier Handover Manifest",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"courier_name\": \"Delhivery\",\n  \"warehouse_id\": \"{{warehouse_id}}\",\n  \"order_ids\": [\"ORD_BOOST_9821\"]\n}"
+            },
+            "url": {
+              "raw": "{{easyecom_base_url}}/shipping/v2/createManifest",
+              "host": ["{{easyecom_base_url}}"],
+              "path": ["shipping", "v2", "createManifest"]
+            },
+            "description": "Creates a courier manifest PDF when handing over physical parcels to delivery rider."
+          }
+        }
+      ]
+    }
+  ]
+}