{ "info": { "name": "MerciSync API v1", "_postman_id": "mercisync-v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Set baseUrl and token. Generated by bin/openapi.php." }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://ecommerce.merciglobal.com" }, { "key": "token", "value": "msk_test_…" } ], "item": [ { "name": "Auth", "item": [ { "name": "Create a tenant + owner user and start the trial", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/register", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "register" ] }, "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"company_name\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"password\": \"string\"\n}" } } }, { "name": "Sign in and get a bearer token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "login" ] }, "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"password\": \"string\"\n}" } } }, { "name": "Revoke the current bearer token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "logout" ] } } }, { "name": "E-mail a password-reset code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/forgot-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "forgot-password" ] }, "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"email\": \"string\"\n}" } } }, { "name": "Set a new password with the e-mailed code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/reset-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "reset-password" ] }, "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"code\": \"string\",\n \"password\": \"string\"\n}" } } }, { "name": "Send (no code) or confirm (with code) the e-mail OTP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/verify-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "verify-email" ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\"\n}" } } }, { "name": "Send (no code) or confirm (with code) the phone OTP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/auth/verify-phone", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "auth", "verify-phone" ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\"\n}" } } }, { "name": "Current user, tenant, scopes and plan", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "me" ] } } } ] }, { "name": "Account", "item": [ { "name": "Tenant profile", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/account", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "account" ] } } }, { "name": "Update tenant profile, GSTIN, address, settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/account", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "account" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"legal_name\": \"string\",\n \"gstin\": \"string\",\n \"pan\": \"string\",\n \"state_code\": \"string\",\n \"address\": {},\n \"contact_email\": \"string\",\n \"contact_phone\": \"string\",\n \"settings\": {\n \"safety_buffer\": 0,\n \"auto_acknowledge\": false,\n \"store_full_address\": false,\n \"low_stock_threshold\": 0\n },\n \"onboarding_step\": 0,\n \"timezone\": \"string\"\n}" } } } ] }, { "name": "Team", "item": [ { "name": "List team members", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "users" ] } } }, { "name": "Invite a team member", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "users" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"role\": \"admin\"\n}" } } }, { "name": "Change role / deactivate", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "users", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"role\": \"owner\",\n \"is_active\": false,\n \"phone\": \"string\"\n}" } } }, { "name": "Remove a team member", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "users", ":id" ] } } } ] }, { "name": "API keys", "item": [ { "name": "List API keys (prefix only)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api-keys" ] } } }, { "name": "Create an API key — the full key is returned once", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api-keys" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"scopes\": [\n \"catalog:read\"\n ]\n}" } } }, { "name": "Revoke an API key", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api-keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api-keys", ":id" ] } } } ] }, { "name": "Catalog", "item": [ { "name": "List products", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ] } } }, { "name": "Create a product (optionally with variants)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ] }, "body": { "mode": "raw", "raw": "{\n \"style_code\": \"K-102\",\n \"title\": \"Cotton Kurta K-102\"\n}" } } }, { "name": "Upsert up to 500 products by style_code / sku", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "bulk" ] }, "body": { "mode": "raw", "raw": "{\n \"products\": [\n {\n \"style_code\": \"K-102\",\n \"title\": \"Cotton Kurta K-102\"\n }\n ]\n}" } } }, { "name": "Get a product", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ] } } }, { "name": "Update a product", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"style_code\": \"K-102\",\n \"title\": \"Cotton Kurta K-102\",\n \"brand\": \"string\",\n \"description\": \"string\",\n \"category_id\": 10,\n \"hsn_code\": \"6204\",\n \"gst_rate\": 0,\n \"country_of_origin\": \"string\",\n \"manufacturer_details\": {},\n \"attributes\": {},\n \"status\": \"draft\"\n}" } } }, { "name": "Delete (soft) a product and its variants", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ] } } }, { "name": "List a product's variants", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id/variants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id", "variants" ] } } }, { "name": "Add a variant", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id/variants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id", "variants" ] }, "body": { "mode": "raw", "raw": "{\n \"sku\": \"K-102-RED-M\",\n \"mrp\": 129900,\n \"selling_price\": 89900\n}" } } }, { "name": "Add an image (multipart \"file\", or JSON {url} fetched async)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id/media", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id", "media" ] } } }, { "name": "List variants (filter[sku] looks up by SKU)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/variants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "variants" ] } } }, { "name": "Get a variant", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/variants/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "variants", ":id" ] } } }, { "name": "Update a variant", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/variants/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "variants", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"sku\": \"K-102-RED-M\",\n \"barcode\": \"string\",\n \"size\": \"string\",\n \"colour\": \"string\",\n \"attributes\": {},\n \"mrp\": 129900,\n \"selling_price\": 89900,\n \"cost_price\": 0,\n \"weight_g\": 0,\n \"length_mm\": 0,\n \"width_mm\": 0,\n \"height_mm\": 0,\n \"safety_buffer\": 0,\n \"low_stock_threshold\": 0,\n \"status\": \"active\"\n}" } } }, { "name": "Delete (soft) a variant", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/variants/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "variants", ":id" ] } } }, { "name": "Reorder an image (position)", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/media/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"position\": 0\n}" } } }, { "name": "Delete an image", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/media/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "media", ":id" ] } } }, { "name": "Internal category taxonomy", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "categories" ] } } }, { "name": "JSON schema of a category's attributes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/categories/:id/schema", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "categories", ":id", "schema" ] } } } ] }, { "name": "Imports & exports", "item": [ { "name": "Upload a .csv/.xlsx (multipart file, type, mode) → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/imports", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "imports" ] } } }, { "name": "List imports", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/imports", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "imports" ] } } }, { "name": "Download a template (?format=csv|xlsx)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/imports/templates/:type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "imports", "templates", ":type" ] } } }, { "name": "Import progress, row errors and error-file URL", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/imports/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "imports", ":id" ] } } }, { "name": "Start an export → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/exports", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "exports" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"catalog\"\n}" } } }, { "name": "Export status and signed download URL", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "exports", ":id" ] } } } ] }, { "name": "Inventory", "item": [ { "name": "List locations", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "locations" ] } } }, { "name": "Create a location", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "locations" ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"name\": \"string\"\n}" } } }, { "name": "Update a location", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "locations", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"name\": \"string\",\n \"address\": {},\n \"pincode\": \"string\",\n \"is_default\": false,\n \"is_active\": false\n}" } } }, { "name": "Stock levels (filter[sku], filter[location], filter[low]=1)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stock", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock" ] } } }, { "name": "Set absolute on_hand for one SKU at one location", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/:sku/:location", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", ":sku", ":location" ] }, "body": { "mode": "raw", "raw": "{\n \"on_hand\": 0\n}" } } }, { "name": "Batch delta adjustments (≤ 1000)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/adjust", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "adjust" ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"string\",\n \"delta\": 0\n }\n ]\n}" } } }, { "name": "Batch absolute sets (≤ 1000) — the ERP sync endpoint", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/set", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "set" ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"string\",\n \"on_hand\": 0\n }\n ]\n}" } } }, { "name": "Stock ledger (append-only)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/movements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "movements" ] } } }, { "name": "Channel stock rules", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/:id/stock-rules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", ":id", "stock-rules" ] } } }, { "name": "Replace channel stock rules", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/:id/stock-rules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", ":id", "stock-rules" ] }, "body": { "mode": "raw", "raw": "{\n \"rules\": [\n {\n \"mode\": \"full\"\n }\n ]\n}" } } } ] }, { "name": "Channels", "item": [ { "name": "Available channels and capabilities", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channels" ] } } }, { "name": "List connected channel accounts", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts" ] } } }, { "name": "Connect a channel: returns an OAuth URL or the credential fields needed", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts" ] }, "body": { "mode": "raw", "raw": "{\n \"channel\": \"fake\"\n}" } } }, { "name": "OAuth return from the marketplace (browser redirect)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/oauth/callback/:channel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", "oauth", "callback", ":channel" ] }, "auth": { "type": "noauth" } } }, { "name": "Get a channel account", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", ":id" ] } } }, { "name": "Update settings / credentials / pause", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"display_name\": \"string\",\n \"settings\": {},\n \"credentials\": {},\n \"is_active\": false,\n \"default_location_id\": \"string\"\n}" } } }, { "name": "Disconnect a channel account", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", ":id" ] } } }, { "name": "Verify credentials → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", ":id", "test" ] } } }, { "name": "Pull existing channel listings and auto-match by SKU → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/:id/import-listings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", ":id", "import-listings" ] } } }, { "name": "Sandbox only: create Fake-marketplace orders and pull them → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/channel-accounts/:id/simulate-orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "channel-accounts", ":id", "simulate-orders" ] }, "body": { "mode": "raw", "raw": "{\n \"count\": 0,\n \"max_qty\": 0,\n \"skus\": [\n \"string\"\n ]\n}" } } }, { "name": "Category mappings (tenant overrides + global defaults)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/category-mappings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "category-mappings" ] } } }, { "name": "Upsert tenant category mappings", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/category-mappings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "category-mappings" ] }, "body": { "mode": "raw", "raw": "{\n \"mappings\": [\n {\n \"channel\": \"string\",\n \"internal_category_id\": 0,\n \"channel_category_ref\": \"string\"\n }\n ]\n}" } } } ] }, { "name": "Listings", "item": [ { "name": "List listings", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/listings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "listings" ] } } }, { "name": "Create listing intents for variants on an account → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/listings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "listings" ] }, "body": { "mode": "raw", "raw": "{\n \"variant_ids\": [\n \"string\"\n ],\n \"channel_account_id\": \"string\"\n}" } } }, { "name": "Link a SKU to an existing channel listing (no create)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/listings/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "listings", "link" ] }, "body": { "mode": "raw", "raw": "{\n \"variant_id\": \"string\",\n \"channel_account_id\": \"string\",\n \"channel_sku\": \"string\"\n}" } } }, { "name": "Price override / activate / deactivate", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/listings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "listings", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"price_override\": 0,\n \"is_active\": false\n}" } } }, { "name": "Re-link this listing to an existing channel listing", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/listings/:id/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "listings", ":id", "link" ] }, "body": { "mode": "raw", "raw": "{\n \"channel_sku\": \"string\"\n}" } } } ] }, { "name": "Sync", "item": [ { "name": "Force a push {scope: stock|price|listing} → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sync/push", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sync", "push" ] }, "body": { "mode": "raw", "raw": "{\n \"scope\": \"stock\"\n}" } } }, { "name": "Sync Health per channel account", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sync/health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sync", "health" ] } } }, { "name": "Sync jobs", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/jobs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "jobs" ] } } }, { "name": "Job status and summarised logs", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/jobs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "jobs", ":id" ] } } }, { "name": "Retry a dead or failed job", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/jobs/:id/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "jobs", ":id", "retry" ] } } } ] }, { "name": "Orders", "item": [ { "name": "List orders", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ] } } }, { "name": "Get an order", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id" ] } } }, { "name": "Acknowledge where the channel requires it → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/accept", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "accept" ] } } }, { "name": "Cancel with a reason (pushed to the channel) → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "cancel" ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}" } } }, { "name": "Mark shipped {awb, courier} → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/ship", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "ship" ] }, "body": { "mode": "raw", "raw": "{\n \"awb\": \"string\",\n \"courier\": \"string\"\n}" } } }, { "name": "Invoice/label URLs from the channel, if any", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id/documents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id", "documents" ] } } }, { "name": "List returns", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/returns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "returns" ] } } }, { "name": "Get a return", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/returns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "returns", ":id" ] } } }, { "name": "Mark received / restock", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/returns/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "returns", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"requested\",\n \"restock\": false,\n \"restock_location_id\": \"string\"\n}" } } }, { "name": "Channel SKUs on orders that match no variant", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/unmapped-skus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "unmapped-skus" ] } } }, { "name": "Map a channel SKU to a variant (links the listing, reserves stock)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/unmapped-skus/map", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "unmapped-skus", "map" ] }, "body": { "mode": "raw", "raw": "{\n \"channel_account_id\": \"string\",\n \"channel_sku\": \"string\",\n \"variant_id\": \"string\"\n}" } } } ] }, { "name": "Webhooks", "item": [ { "name": "List webhook endpoints", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/webhook-endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhook-endpoints" ] } } }, { "name": "Create an endpoint (secret returned once)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/webhook-endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhook-endpoints" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"events\": [\n \"order.created\"\n ]\n}" } } }, { "name": "Update an endpoint", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/webhook-endpoints/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhook-endpoints", ":id" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"events\": [\n \"string\"\n ],\n \"is_active\": false\n}" } } }, { "name": "Delete an endpoint", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/webhook-endpoints/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhook-endpoints", ":id" ] } } }, { "name": "Send a signed test event → 202", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/webhook-endpoints/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhook-endpoints", ":id", "test" ] } } }, { "name": "Delivery log", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/webhook-deliveries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "webhook-deliveries" ] } } } ] }, { "name": "Billing", "item": [ { "name": "Public plans and limits", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/plans", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "plans" ] }, "auth": { "type": "noauth" } } }, { "name": "Current subscription", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/subscription", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "subscription" ] } } }, { "name": "GST invoices", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/invoices", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "invoices" ] } } }, { "name": "Usage against plan limits", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/usage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "usage" ] } } }, { "name": "A checkout / payment", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/payments/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "payments", ":id" ] } } }, { "name": "Sandbox simulator only: complete or fail a checkout via a signed gateway webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/payments/:id/simulate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "payments", ":id", "simulate" ] }, "body": { "mode": "raw", "raw": "{\n \"result\": \"success\"\n}" } } }, { "name": "Start a Cashfree checkout for a plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/checkout", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "checkout" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_code\": \"starter\"\n}" } } }, { "name": "Upgrade now (prorated checkout) or downgrade at period end", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/change-plan", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "change-plan" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_code\": \"starter\"\n}" } } }, { "name": "Cancel at period end", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/billing/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "cancel" ] } } } ] }, { "name": "Reports", "item": [ { "name": "Dashboard aggregates (filter[from], filter[to], filter[channel_account])", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "dashboard" ] } } } ] }, { "name": "Misc", "item": [ { "name": "Liveness (public)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "health" ] }, "auth": { "type": "noauth" } } } ] } ] }