{ "info": { "_postman_id": "3a1f0c2e-9b7d-4e6a-8f21-gini2third00", "name": "Gini API v2 - Third Party", "description": "Signed (API key + HMAC-SHA256) collection for the Gini v2 Third-Party API. Set api_client_id and api_client_secret in Collection Variables — the collection pre-request script builds the X-SIGNATURE and X-TIMESTAMP headers on every send.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Signs every request: HMAC-SHA256(method + path + body + timestamp, api_client_secret)", "// Set api_client_id and api_client_secret in the Collection Variables tab first.", "var API_SECRET = pm.collectionVariables.get('api_client_secret');", "if (!API_SECRET || API_SECRET === '') {", " console.warn('api_client_secret is not set. Open Collection Variables and set it.');", " return;", "}", "", "var method = pm.request.method;", "", "var url = pm.request.url.toString();", "url = url.replace(/\\{\\{(.*?)\\}\\}/g, function (_, v) {", " return pm.collectionVariables.get(v) || pm.variables.get(v) || '';", "});", "", "var path;", "try {", " path = new URL(url).pathname;", "} catch (e) {", " path = '/' + url.replace(/^https?:\\/\\/[^\\/]+/, '').replace(/\\?.*$/, '').replace(/^\\/+/, '');", "}", "", "var timestamp = Math.floor(Date.now() / 1000).toString();", "", "var body = '';", "if (pm.request.body && pm.request.body.raw) {", " body = pm.request.body.raw.replace(/\\{\\{(.*?)\\}\\}/g, function (_, v) {", " return pm.collectionVariables.get(v) || pm.variables.get(v) || '';", " });", "}", "", "var signingString = method + path + body + timestamp;", "var signature = CryptoJS.HmacSHA256(signingString, API_SECRET).toString();", "", "pm.request.headers.upsert({ key: 'X-SIGNATURE', value: signature });", "pm.request.headers.upsert({ key: 'X-TIMESTAMP', value: timestamp });", "", "// Idempotency-Key: only requests that declare the header take part.", "// Empty idempotency_key means a fresh key per send, which is normal behaviour.", "// Pin a key in idempotency_key and resend to watch the original response replay.", "if (pm.request.headers.has('Idempotency-Key')) {", " var pinnedKey = (pm.collectionVariables.get('idempotency_key') || '').trim();", " var idempotencyKey = pinnedKey !== '' ? pinnedKey : pm.variables.replaceIn('{{$guid}}');", "", " pm.collectionVariables.set('last_idempotency_key', idempotencyKey);", " pm.request.headers.upsert({ key: 'Idempotency-Key', value: idempotencyKey });", "}" ] } } ], "variable": [ { "key": "base_url", "value": "https://app.gini.iq/api/v2.0/third-party" }, { "key": "api_client_id", "value": "" }, { "key": "api_client_secret", "value": "" }, { "key": "category_slug", "value": "electronics" }, { "key": "sku", "value": "WH-2026-001" }, { "key": "attribute_id", "value": "1" }, { "key": "variant_id", "value": "1" }, { "key": "order_id", "value": "1" }, { "key": "export_id", "value": "" }, { "key": "web_base_url", "value": "https://app.gini.iq" }, { "key": "print_timestamp", "value": "" }, { "key": "print_signature", "value": "" }, { "key": "wholesale_base_url", "value": "https://app.gini.iq/api/v1.0/third-party/wholesale" }, { "key": "catalog_product_id", "value": "142" }, { "key": "cart_item_id", "value": "4821" }, { "key": "wholesale_order_id", "value": "4012" }, { "key": "idempotency_key", "value": "", "type": "string", "description": "Leave empty for a fresh key on every send. Paste a key here to pin it, then resend a creating request to see the replayed response." }, { "key": "last_idempotency_key", "value": "", "type": "string", "description": "Read-only. The key the last creating request actually sent — copy it into idempotency_key to replay." } ], "item": [ { "name": "Ping", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/ping", "host": [ "{{base_url}}" ], "path": [ "ping" ] }, "description": "Connectivity check. Signed like every other route, so a 200 proves the whole auth chain works before you attempt a business call. The response echoes the exact string the server signed, which is what to diff against your own signing string when a 401 will not go away." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('signed request reaches the API', function () {", " pm.response.to.have.status(200);", "});", "", "pm.test('the server signed the path without a query string', function () {", " var signed = pm.response.json().data.signature.signed_path;", " pm.expect(signed).to.not.include('?');", "});" ] } } ], "response": [] }, { "name": "Profile", "item": [ { "name": "Read profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/profile", "host": [ "{{base_url}}" ], "path": [ "profile" ] } }, "response": [] }, { "name": "Update profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/profile", "host": [ "{{base_url}}" ], "path": [ "profile" ] }, "body": { "mode": "raw", "raw": "{\n \"business_name\": \"My Store\",\n \"business_type\": \"electronics\",\n \"business_phone\": \"07701234567\",\n \"state\": 1,\n \"district\": 1,\n \"nearest_function_point\": \"Near the tower\",\n \"latitude\": 33.31,\n \"longitude\": 44.36\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace logo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/profile/logo", "host": [ "{{base_url}}" ], "path": [ "profile", "logo" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "logo", "type": "file", "src": [] } ] } }, "response": [] }, { "name": "Replace cover", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/profile/cover", "host": [ "{{base_url}}" ], "path": [ "profile", "cover" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "cover", "type": "file", "src": [] } ] } }, "response": [] } ] }, { "name": "Categories", "item": [ { "name": "List Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/categories", "host": [ "{{base_url}}" ], "path": [ "categories" ] } }, "response": [] }, { "name": "Show Category Subcategories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/categories/{{category_slug}}", "host": [ "{{base_url}}" ], "path": [ "categories", "{{category_slug}}" ] } }, "response": [] } ] }, { "name": "Products", "item": [ { "name": "List Products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/products?search=&per_page=15", "host": [ "{{base_url}}" ], "path": [ "products" ], "query": [ { "key": "search", "value": "" }, { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Show Product", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}" ] } }, "response": [] }, { "name": "Create Product", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/products", "host": [ "{{base_url}}" ], "path": [ "products" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Wireless Headphones", "type": "text" }, { "key": "description", "value": "Premium noise-cancelling headphones.", "type": "text" }, { "key": "price", "value": "45000", "type": "text" }, { "key": "quantity", "value": "120", "type": "text" }, { "key": "security_stock", "value": "10", "type": "text" }, { "key": "category_id", "value": "3", "type": "text" }, { "key": "subcategory_id", "value": "12", "type": "text" }, { "key": "is_visible", "value": "1", "type": "text" }, { "key": "sku", "value": "{{sku}}", "type": "text" }, { "key": "images[]", "type": "file", "src": [] } ] } }, "response": [] }, { "name": "Update Product", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/products/{{sku}}", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Wireless Headphones Pro\",\n \"price\": 52000,\n \"is_visible\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Product", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}" ] } }, "response": [] }, { "name": "Update Stock", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/stock", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "stock" ] }, "body": { "mode": "raw", "raw": "{\n \"price\": 22000,\n \"quantity\": 50\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Bulk Upsert Products", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/products/bulk", "host": [ "{{base_url}}" ], "path": [ "products", "bulk" ] }, "body": { "mode": "raw", "raw": "{\n \"products\": [\n {\n \"name\": \"T-Shirt Red\",\n \"sku\": \"TSHIRT-RED-M\",\n \"description\": \"Cotton t-shirt, red, medium.\",\n \"price\": 12000,\n \"quantity\": 50,\n \"security_stock\": 5,\n \"category_id\": 4,\n \"subcategory_id\": 18,\n \"is_visible\": 1,\n \"is_gini_partner\": false\n },\n {\n \"name\": \"T-Shirt Blue\",\n \"description\": \"Cotton t-shirt, blue, large.\",\n \"price\": 12000,\n \"quantity\": 40,\n \"security_stock\": 5,\n \"category_id\": 4,\n \"subcategory_id\": 18,\n \"is_visible\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Bulk Update Stock", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/products/stock-updates", "host": [ "{{base_url}}" ], "path": [ "products", "stock-updates" ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"TSHIRT\",\n \"price\": 25000,\n \"quantity\": 40\n },\n {\n \"sku\": \"TSHIRT\",\n \"variant_id\": 8812,\n \"quantity\": 12\n },\n {\n \"sku\": \"MUG-01\",\n \"price\": 9750,\n \"is_visible\": true\n },\n {\n \"sku\": \"CAP-02\",\n \"is_visible\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Set new prices and quantities for up to 500 products or variants, and switch products on or off. Each item is a product's sku with a whole-IQD price, a quantity (whole number, 0 or more), an is_visible (true/false), or any of them, plus an optional variant_id under that product (is_visible is for products only). A malformed request is refused with 422; a SKU or variant you do not have is ignored. An accepted request answers 202 and the items are written in the background." }, "response": [] }, { "name": "Bulk Delete Products", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/products/bulk-delete", "host": [ "{{base_url}}" ], "path": [ "products", "bulk-delete" ] }, "body": { "mode": "raw", "raw": "{\n \"skus\": [\n \"TSHIRT\",\n \"MUG-01\",\n \"16 PRO\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Delete up to 500 products by SKU, sent as a JSON skus list. Requires a configured webhook. The request is checked first (422 when malformed); an accepted request answers 202 with an id, and the products are deleted in the background. A SKU you do not have is ignored. When the run ends, a product_bulk_delete_finished webhook carries the deleted count and every one of your products that was not deleted, with the reason (has_orders or error)." }, "response": [] } ] }, { "name": "Product Variants", "item": [ { "name": "Generate Variant Combinations", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/products/variants/generate", "host": [ "{{base_url}}" ], "path": [ "products", "variants", "generate" ] }, "body": { "mode": "raw", "raw": "{\n \"attributes\": [\n {\n \"attribute_id\": 1,\n \"name\": \"Color\",\n \"values\": [\n \"Red\",\n \"Blue\"\n ]\n },\n {\n \"attribute_id\": 2,\n \"name\": \"Size\",\n \"values\": [\n \"S\",\n \"M\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Save Variants", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/variants", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "variants" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "_method", "value": "PUT", "type": "text" }, { "key": "variants[0][sku]", "value": "WH-BLUE-M", "type": "text" }, { "key": "variants[0][price]", "value": "48000", "type": "text" }, { "key": "variants[0][quantity]", "value": "30", "type": "text" }, { "key": "variants[0][attributes][0][attribute_id]", "value": "1", "type": "text" }, { "key": "variants[0][attributes][0][value]", "value": "Blue", "type": "text" }, { "key": "variants[0][attributes][1][attribute_id]", "value": "2", "type": "text" }, { "key": "variants[0][attributes][1][value]", "value": "M", "type": "text" }, { "key": "variants[0][image]", "type": "file", "src": [] } ] } }, "response": [] }, { "name": "List Variants", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/variants", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "variants" ] } }, "response": [] }, { "name": "Show Variant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/variants/{{variant_id}}", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "variants", "{{variant_id}}" ] } }, "response": [] }, { "name": "Delete Variant", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/variants/{{variant_id}}", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "variants", "{{variant_id}}" ] } }, "response": [] } ] }, { "name": "Product Add-ons", "item": [ { "name": "List add-ons", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/addons?per_page=15", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "addons" ], "query": [ { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get add-on", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/addons/{{addon_id}}", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "addons", "{{addon_id}}" ] } }, "response": [] }, { "name": "Create add-on", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/addons", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "addons" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Gift wrap\",\n \"description\": \"Wrapped in premium paper\",\n \"price\": 2000,\n \"quantity\": 100,\n \"max_quantity\": 1,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update add-on", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/addons/{{addon_id}}", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "addons", "{{addon_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"price\": 2500,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete add-on", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/products/{{sku}}/addons/{{addon_id}}", "host": [ "{{base_url}}" ], "path": [ "products", "{{sku}}", "addons", "{{addon_id}}" ] } }, "response": [] } ] }, { "name": "Attributes", "item": [ { "name": "List Attributes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/attributes?query=", "host": [ "{{base_url}}" ], "path": [ "attributes" ], "query": [ { "key": "query", "value": "" } ] } }, "response": [] }, { "name": "Get Attribute", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/attributes/{{attribute_id}}", "host": [ "{{base_url}}" ], "path": [ "attributes", "{{attribute_id}}" ] } }, "response": [] }, { "name": "Create Attribute", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/attributes", "host": [ "{{base_url}}" ], "path": [ "attributes" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Color\",\n \"type\": \"color\",\n \"values\": [\n \"Red\",\n \"Blue\",\n \"Green\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Attribute", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/attributes/{{attribute_id}}", "host": [ "{{base_url}}" ], "path": [ "attributes", "{{attribute_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Color\",\n \"type\": \"color\",\n \"values\": [\n \"Red\",\n \"Blue\",\n \"Green\",\n \"Black\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Attribute", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/attributes/{{attribute_id}}", "host": [ "{{base_url}}" ], "path": [ "attributes", "{{attribute_id}}" ] } }, "response": [] } ] }, { "name": "Discounts", "item": [ { "name": "List Discounts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/discounts?query=", "host": [ "{{base_url}}" ], "path": [ "discounts" ], "query": [ { "key": "query", "value": "" } ] } }, "response": [] }, { "name": "Get a Discount", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/discounts/{{discount_id}}", "host": [ "{{base_url}}" ], "path": [ "discounts", "{{discount_id}}" ] } }, "response": [] }, { "name": "Create a Discount", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/discounts", "host": [ "{{base_url}}" ], "path": [ "discounts" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Ramadan Sale", "type": "text" }, { "key": "code", "value": "RAMADAN20", "type": "text" }, { "key": "type", "value": "percentage", "type": "text", "description": "percentage (default) or amount." }, { "key": "percentage", "value": "20", "type": "text" }, { "key": "max_amount", "value": "5000", "type": "text", "description": "Optional per-unit cap in IQD for a percentage.", "disabled": true }, { "key": "amount", "value": "2500", "type": "text", "description": "IQD off each unit, for type amount.", "disabled": true }, { "key": "scope", "value": "products", "type": "text", "description": "products (default), all, category or subcategories." }, { "key": "category_id", "value": "3", "type": "text", "description": "For scope category or subcategories.", "disabled": true }, { "key": "subcategory_ids[]", "value": "12", "type": "text", "description": "For scope subcategories.", "disabled": true }, { "key": "max_usage", "value": "100", "type": "text" }, { "key": "expires_at", "value": "2027-01-31", "type": "text" }, { "key": "is_active", "value": "1", "type": "text" }, { "key": "product_ids[]", "value": "{{product_id}}", "type": "text", "description": "For scope products." }, { "key": "image", "type": "file", "src": [] } ] } }, "response": [] }, { "name": "Update a Discount", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/discounts/{{discount_id}}", "host": [ "{{base_url}}" ], "path": [ "discounts", "{{discount_id}}" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "percentage", "value": "35", "type": "text" }, { "key": "max_amount", "value": "5000", "type": "text", "description": "Optional per-unit cap in IQD for a percentage.", "disabled": true } ] } }, "response": [] }, { "name": "Delete a Discount", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/discounts/{{discount_id}}", "host": [ "{{base_url}}" ], "path": [ "discounts", "{{discount_id}}" ] } }, "response": [] } ] }, { "name": "Abandoned Carts", "item": [ { "name": "List Abandoned Carts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/abandoned-carts?search=&hours=&product_id=&sort=recent&per_page=15", "host": [ "{{base_url}}" ], "path": [ "abandoned-carts" ], "query": [ { "key": "search", "value": "" }, { "key": "hours", "value": "" }, { "key": "product_id", "value": "" }, { "key": "sort", "value": "recent" }, { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get Customer Cart", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/abandoned-carts/{{customer_id}}", "host": [ "{{base_url}}" ], "path": [ "abandoned-carts", "{{customer_id}}" ] } }, "response": [] } ] }, { "name": "Reviews", "item": [ { "name": "List Reviews", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/reviews?search=&rating=&subject=&per_page=15", "host": [ "{{base_url}}" ], "path": [ "reviews" ], "query": [ { "key": "search", "value": "" }, { "key": "rating", "value": "" }, { "key": "subject", "value": "" }, { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get a Review", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/reviews/{{review_id}}", "host": [ "{{base_url}}" ], "path": [ "reviews", "{{review_id}}" ] } }, "response": [] } ] }, { "name": "Notifications", "item": [ { "name": "List notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/notifications?type=all&per_page=20", "host": [ "{{base_url}}" ], "path": [ "notifications" ], "query": [ { "key": "type", "value": "all" }, { "key": "per_page", "value": "20" } ] } }, "response": [] }, { "name": "Unread count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/notifications/unread-count", "host": [ "{{base_url}}" ], "path": [ "notifications", "unread-count" ] } }, "response": [] }, { "name": "Mark all read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/notifications/read-all", "host": [ "{{base_url}}" ], "path": [ "notifications", "read-all" ] } }, "response": [] }, { "name": "Mark one read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/notifications/{{notification_id}}/read", "host": [ "{{base_url}}" ], "path": [ "notifications", "{{notification_id}}", "read" ] } }, "response": [] }, { "name": "Delete notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/notifications/{{notification_id}}", "host": [ "{{base_url}}" ], "path": [ "notifications", "{{notification_id}}" ] } }, "response": [] }, { "name": "Mark several read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/notifications/read", "host": [ "{{base_url}}" ], "path": [ "notifications", "read" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"{{notification_id}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete several", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/notifications", "host": [ "{{base_url}}" ], "path": [ "notifications" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"{{notification_id}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Settlements", "item": [ { "name": "List Settlements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/settlements?per_page=15", "host": [ "{{base_url}}" ], "path": [ "settlements" ], "query": [ { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get a Settlement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/settlements/{{settlement_id}}", "host": [ "{{base_url}}" ], "path": [ "settlements", "{{settlement_id}}" ] } }, "response": [] }, { "name": "Settlement stats", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/settlements/stats?from=2026-01-01&to=2026-12-31", "host": [ "{{base_url}}" ], "path": [ "settlements", "stats" ], "query": [ { "key": "from", "value": "2026-01-01" }, { "key": "to", "value": "2026-12-31" } ] } }, "response": [] }, { "name": "Export a settlement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/settlements/{{settlement_id}}/export", "host": [ "{{base_url}}" ], "path": [ "settlements", "{{settlement_id}}", "export" ] } }, "response": [] }, { "name": "Export filtered settlements", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/settlements/export", "host": [ "{{base_url}}" ], "path": [ "settlements", "export" ] }, "body": { "mode": "raw", "raw": "{\n \"types\": [\n \"epay\"\n ],\n \"from\": \"2026-01-01\",\n \"to\": \"2026-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Debts", "item": [ { "name": "List Debts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/debts?status=&per_page=15", "host": [ "{{base_url}}" ], "path": [ "debts" ], "query": [ { "key": "status", "value": "" }, { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get a Debt", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/debts/{{debt_id}}", "host": [ "{{base_url}}" ], "path": [ "debts", "{{debt_id}}" ] } }, "response": [] }, { "name": "Debt stats", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/debts/stats", "host": [ "{{base_url}}" ], "path": [ "debts", "stats" ] } }, "response": [] } ] }, { "name": "Transactions", "item": [ { "name": "List transactions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/transactions?per_page=15", "host": [ "{{base_url}}" ], "path": [ "transactions" ], "query": [ { "key": "per_page", "value": "15" } ] } }, "response": [] } ] }, { "name": "Collections", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/collections?per_page=15", "host": [ "{{base_url}}" ], "path": [ "collections" ], "query": [ { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get one", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/collections/{{collection_id}}", "host": [ "{{base_url}}" ], "path": [ "collections", "{{collection_id}}" ] } }, "response": [] }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/collections", "host": [ "{{base_url}}" ], "path": [ "collections" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Summer Picks", "type": "text" }, { "key": "description", "value": "Our summer favourites", "type": "text" }, { "key": "is_main", "value": "0", "type": "text" }, { "key": "product_ids[]", "value": "{{product_id}}", "type": "text" }, { "key": "image", "type": "file", "src": [] } ] } }, "response": [] }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/collections/{{collection_id}}", "host": [ "{{base_url}}" ], "path": [ "collections", "{{collection_id}}" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Summer Picks 2", "type": "text" } ] } }, "response": [] }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/collections/{{collection_id}}", "host": [ "{{base_url}}" ], "path": [ "collections", "{{collection_id}}" ] } }, "response": [] } ] }, { "name": "Influencers", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/influencers?per_page=15", "host": [ "{{base_url}}" ], "path": [ "influencers" ], "query": [ { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get one", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/influencers/{{influencer_id}}", "host": [ "{{base_url}}" ], "path": [ "influencers", "{{influencer_id}}" ] } }, "response": [] }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/influencers", "host": [ "{{base_url}}" ], "path": [ "influencers" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Zaid\",\n \"email\": \"zaid@example.com\",\n \"code\": \"ZAID10\",\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/influencers/{{influencer_id}}", "host": [ "{{base_url}}" ], "path": [ "influencers", "{{influencer_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/influencers/{{influencer_id}}", "host": [ "{{base_url}}" ], "path": [ "influencers", "{{influencer_id}}" ] } }, "response": [] } ] }, { "name": "Branches", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/branches?per_page=15", "host": [ "{{base_url}}" ], "path": [ "branches" ], "query": [ { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get one", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/branches/{{branch_id}}", "host": [ "{{base_url}}" ], "path": [ "branches", "{{branch_id}}" ] } }, "response": [] }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/branches", "host": [ "{{base_url}}" ], "path": [ "branches" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Karrada Branch\",\n \"email\": \"karrada@example.com\",\n \"phone\": \"07701234567\",\n \"business_phone\": \"07701234568\",\n \"state\": 1,\n \"nearest_function_point\": \"Near the tower\",\n \"latitude\": 33.31,\n \"longitude\": 44.36,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/branches/{{branch_id}}", "host": [ "{{base_url}}" ], "path": [ "branches", "{{branch_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/branches/{{branch_id}}", "host": [ "{{base_url}}" ], "path": [ "branches", "{{branch_id}}" ] } }, "response": [] } ] }, { "name": "Operators", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/operators?per_page=15", "host": [ "{{base_url}}" ], "path": [ "operators" ], "query": [ { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Get one", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/operators/{{operator_id}}", "host": [ "{{base_url}}" ], "path": [ "operators", "{{operator_id}}" ] } }, "response": [] }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/operators", "host": [ "{{base_url}}" ], "path": [ "operators" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Cashier One\",\n \"email\": \"cashier1@example.com\",\n \"phone\": \"07701234569\",\n \"password\": \"Str0ng@Pass1\",\n \"role\": \"cashier\",\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/operators/{{operator_id}}", "host": [ "{{base_url}}" ], "path": [ "operators", "{{operator_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"manager\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/operators/{{operator_id}}", "host": [ "{{base_url}}" ], "path": [ "operators", "{{operator_id}}" ] } }, "response": [] } ] }, { "name": "Opening Hours", "item": [ { "name": "Get Opening Hours", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/opening-hours?store_id=", "host": [ "{{base_url}}" ], "path": [ "opening-hours" ], "query": [ { "key": "store_id", "value": "" } ] } }, "response": [] }, { "name": "Set Opening Hours", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/opening-hours", "host": [ "{{base_url}}" ], "path": [ "opening-hours" ] }, "body": { "mode": "raw", "raw": "{\n \"store_id\": null,\n \"week\": {\n \"sat\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"sun\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"mon\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"tue\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"wed\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"thu\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"fri\": {\n \"is_open\": false\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Ordering Schedule", "item": [ { "name": "Get Ordering Schedule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/ordering-schedule?store_id=", "host": [ "{{base_url}}" ], "path": [ "ordering-schedule" ], "query": [ { "key": "store_id", "value": "" } ] } }, "response": [] }, { "name": "Set Ordering Schedule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/ordering-schedule", "host": [ "{{base_url}}" ], "path": [ "ordering-schedule" ] }, "body": { "mode": "raw", "raw": "{\n \"store_id\": null,\n \"week\": {\n \"sat\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"sun\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"mon\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"tue\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"wed\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"thu\": {\n \"is_open\": true,\n \"start_time\": \"09:00\",\n \"end_time\": \"22:00\"\n },\n \"fri\": {\n \"is_open\": false\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Delivery Settings", "item": [ { "name": "Get Delivery Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/delivery-settings", "host": [ "{{base_url}}" ], "path": [ "delivery-settings" ] } }, "response": [] }, { "name": "Update Delivery Settings", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/delivery-settings", "host": [ "{{base_url}}" ], "path": [ "delivery-settings" ] }, "body": { "mode": "raw", "raw": "{\n \"allow_pickup\": true,\n \"allow_delivery\": true,\n \"shipment_charges\": [\n {\n \"state_id\": 1,\n \"cost\": 5000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Dashboard Stats", "item": [ { "name": "Get Dashboard Stats", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/dashboard-stats?year=", "host": [ "{{base_url}}" ], "path": [ "dashboard-stats" ], "query": [ { "key": "year", "value": "" } ] } }, "response": [] } ] }, { "name": "Orders", "item": [ { "name": "List Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/orders?search=&status=&per_page=15", "host": [ "{{base_url}}" ], "path": [ "orders" ], "query": [ { "key": "search", "value": "" }, { "key": "status", "value": "" }, { "key": "per_page", "value": "15" } ] } }, "response": [] }, { "name": "Show Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}" ] } }, "response": [] }, { "name": "Accept Order", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"accepted\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Reject Order", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"rejected\",\n \"reject_reason_id\": 3,\n \"reject_reason_notes\": \"Item damaged in warehouse\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Order On The Way", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"on_the_way\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deliver Order", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"delivered\",\n \"code\": \"483921\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Return Order", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"returned\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Print Order Receipt", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Query-param HMAC for the browser-openable print receipt.", "// Signs GET + PATH + TIMESTAMP (no body — the URL is the whole request).", "var secret = pm.collectionVariables.get('api_client_secret');", "if (!secret || secret === '') {", " console.warn('api_client_secret is not set. Open Collection Variables and set it.');", " return;", "}", "", "var orderId = pm.collectionVariables.get('order_id');", "var timestamp = Math.floor(Date.now() / 1000).toString();", "var path = '/print/receipt/' + orderId;", "var signature = CryptoJS.HmacSHA256('GET' + path + timestamp, secret).toString();", "", "pm.collectionVariables.set('print_timestamp', timestamp);", "pm.collectionVariables.set('print_signature', signature);" ] } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/html" } ], "url": { "raw": "{{web_base_url}}/print/receipt/{{order_id}}?api_key={{api_client_id}}×tamp={{print_timestamp}}&signature={{print_signature}}", "host": [ "{{web_base_url}}" ], "path": [ "print", "receipt", "{{order_id}}" ], "query": [ { "key": "api_key", "value": "{{api_client_id}}" }, { "key": "timestamp", "value": "{{print_timestamp}}" }, { "key": "signature", "value": "{{print_signature}}" } ] }, "description": "Browser-openable printable HTML receipt/invoice/sticker. Query-param HMAC (GET + PATH + TIMESTAMP, no body) — distinct from the header scheme. Lives on the web host, not the API base." }, "response": [] }, { "name": "Rejection reasons", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/orders/rejection-reasons", "host": [ "{{base_url}}" ], "path": [ "orders", "rejection-reasons" ] } }, "response": [] }, { "name": "Hand off to delivery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}/handoff", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}", "handoff" ] } }, "response": [] }, { "name": "Reset delivery handoff", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}/handoff/reset", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}", "handoff", "reset" ] } }, "response": [] }, { "name": "Request cancellation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "X-TIMESTAMP", "value": "{{timestamp}}" }, { "key": "X-SIGNATURE", "value": "{{signature}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/orders/{{order_id}}/request-cancellation", "host": [ "{{base_url}}" ], "path": [ "orders", "{{order_id}}", "request-cancellation" ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer changed their mind\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Reels", "description": "Merchant-authored short videos. Every route needs reels enabled for the account (enable_add_reel) or returns 403.", "item": [ { "name": "List Reels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/reels?per_page=15", "host": [ "{{base_url}}" ], "path": [ "reels" ] } }, "response": [] }, { "name": "Get Reel", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/reels/{{reel_id}}", "host": [ "{{base_url}}" ], "path": [ "reels", "{{reel_id}}" ] } }, "response": [] }, { "name": "Create Reel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/reels", "host": [ "{{base_url}}" ], "path": [ "reels" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Summer promo", "type": "text" }, { "key": "description", "value": "A short clip", "type": "text" }, { "key": "video", "src": [], "type": "file" }, { "key": "preview_image", "src": [], "type": "file" }, { "key": "is_active", "value": "1", "type": "text" } ] } }, "response": [] }, { "name": "Update Reel", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/reels/{{reel_id}}", "host": [ "{{base_url}}" ], "path": [ "reels", "{{reel_id}}" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Renamed", "type": "text" } ] } }, "response": [] }, { "name": "Delete Reel", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/reels/{{reel_id}}", "host": [ "{{base_url}}" ], "path": [ "reels", "{{reel_id}}" ] } }, "response": [] } ] }, { "name": "Exports", "item": [ { "name": "Export Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/exports/orders", "host": [ "{{base_url}}" ], "path": [ "exports", "orders" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"delivered\",\n \"date\": \"2026-02-10\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 202) {", " var id = pm.response.json().data.export_id;", " pm.collectionVariables.set('export_id', id);", " console.log('Saved export_id =', id);", "}" ] } } ] }, { "name": "Export Products", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/exports/products", "host": [ "{{base_url}}" ], "path": [ "exports", "products" ] }, "body": { "mode": "raw", "raw": "{\n \"search\": \"headphones\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 202) {", " var id = pm.response.json().data.export_id;", " pm.collectionVariables.set('export_id', id);", " console.log('Saved export_id =', id);", "}" ] } } ] }, { "name": "Export Abandoned Carts", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/exports/abandoned-carts", "host": [ "{{base_url}}" ], "path": [ "exports", "abandoned-carts" ] }, "body": { "mode": "raw", "raw": "{\n \"hours\": 24\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 202) {", " var id = pm.response.json().data.export_id;", " pm.collectionVariables.set('export_id', id);", " console.log('Saved export_id =', id);", "}" ] } } ] }, { "name": "Export Wholesale Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/exports/wholesale-orders", "host": [ "{{base_url}}" ], "path": [ "exports", "wholesale-orders" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"delivered\",\n \"columns\": [\"id\", \"buyer\", \"total\", \"ordered_at\"]\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 202) {", " var id = pm.response.json().data.export_id;", " pm.collectionVariables.set('export_id', id);", " console.log('Saved export_id =', id);", "}" ] } } ] }, { "name": "Export Stock Template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{base_url}}/exports/stock-template", "host": [ "{{base_url}}" ], "path": [ "exports", "stock-template" ] }, "body": { "mode": "raw", "raw": "{\n \"stock\": \"low\",\n \"include_variants\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 202) {", " var id = pm.response.json().data.export_id;", " pm.collectionVariables.set('export_id', id);", " console.log('Saved export_id =', id);", "}" ] } } ] }, { "name": "Check Export Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/exports/{{export_id}}", "host": [ "{{base_url}}" ], "path": [ "exports", "{{export_id}}" ] } }, "response": [] } ] }, { "name": "Webhooks", "item": [ { "name": "Get Webhook Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/webhook", "host": [ "{{base_url}}" ], "path": [ "webhook" ] } }, "response": [] }, { "name": "Update Webhook Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhook", "host": [ "{{base_url}}" ], "path": [ "webhook" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://your-server.com/webhook\",\n \"auth_type\": \"bearer\",\n \"auth_value\": \"your-secret-token\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Webhook Config", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/webhook", "host": [ "{{base_url}}" ], "path": [ "webhook" ] } }, "response": [] }, { "name": "Test Webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{base_url}}/webhook/test", "host": [ "{{base_url}}" ], "path": [ "webhook", "test" ] } }, "response": [] } ] }, { "name": "Wholesale (B2B)", "description": "Merchant-to-merchant wholesale marketplace. NOTE: these endpoints live under {{wholesale_base_url}} (api/v1.0/third-party/wholesale), a different base from the rest of the collection, but use the same API key + HMAC signing.", "item": [ { "name": "List Buyers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/buyers?sort=spend", "host": [ "{{wholesale_base_url}}" ], "path": [ "buyers" ], "query": [ { "key": "sort", "value": "spend" } ] } }, "response": [] }, { "name": "Catalog", "item": [ { "name": "List wholesale sellers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/catalog/sellers", "host": [ "{{wholesale_base_url}}" ], "path": [ "catalog", "sellers" ], "query": [ { "key": "search", "value": "", "disabled": true }, { "key": "category_id", "value": "", "disabled": true }, { "key": "subcategory_id", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "List wholesale products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/catalog", "host": [ "{{wholesale_base_url}}" ], "path": [ "catalog" ], "query": [ { "key": "search", "value": "", "disabled": true }, { "key": "category_id", "value": "", "disabled": true }, { "key": "subcategory_id", "value": "", "disabled": true }, { "key": "client_id", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "Show wholesale product", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/catalog/{{catalog_product_id}}", "host": [ "{{wholesale_base_url}}" ], "path": [ "catalog", "{{catalog_product_id}}" ] } }, "response": [] } ] }, { "name": "Cart", "item": [ { "name": "View cart", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/cart", "host": [ "{{wholesale_base_url}}" ], "path": [ "cart" ] } }, "response": [] }, { "name": "Add item to cart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{wholesale_base_url}}/cart", "host": [ "{{wholesale_base_url}}" ], "path": [ "cart" ] }, "body": { "mode": "raw", "raw": "{\n \"product_id\": 142,\n \"product_variant_id\": 1167,\n \"quantity\": 12\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update cart item quantity", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wholesale_base_url}}/cart/{{cart_item_id}}", "host": [ "{{wholesale_base_url}}" ], "path": [ "cart", "{{cart_item_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"type\": \"+\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove cart item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/cart/{{cart_item_id}}", "host": [ "{{wholesale_base_url}}" ], "path": [ "cart", "{{cart_item_id}}" ] } }, "response": [] }, { "name": "Clear cart", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/cart", "host": [ "{{wholesale_base_url}}" ], "path": [ "cart" ] } }, "response": [] } ] }, { "name": "Buyer Orders", "item": [ { "name": "List buyer orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/buyer", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "buyer" ], "query": [ { "key": "status", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "Place buyer order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" }, { "key": "Idempotency-Key", "value": "{{idempotency_key}}", "type": "text", "description": "Optional. Retry-safe key you generate before the first attempt. Resending the same key returns the original response instead of creating a second record. The collection pre-request script fills this in — see the idempotency_key variable." } ], "url": { "raw": "{{wholesale_base_url}}/orders/buyer", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "buyer" ] } }, "response": [] }, { "name": "Show buyer order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/buyer/{{wholesale_order_id}}", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "buyer", "{{wholesale_order_id}}" ] } }, "response": [] }, { "name": "Confirm order received", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/buyer/{{wholesale_order_id}}/confirm-received", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "buyer", "{{wholesale_order_id}}", "confirm-received" ] } }, "response": [] }, { "name": "Cancel buyer order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/buyer/{{wholesale_order_id}}/cancel", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "buyer", "{{wholesale_order_id}}", "cancel" ] } }, "response": [] } ] }, { "name": "Seller Orders", "item": [ { "name": "List seller orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/seller", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "seller" ], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "page", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "Show seller order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/seller/{{wholesale_order_id}}", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "seller", "{{wholesale_order_id}}" ] } }, "response": [] }, { "name": "Accept seller order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/seller/{{wholesale_order_id}}/accept", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "seller", "{{wholesale_order_id}}", "accept" ] } }, "response": [] }, { "name": "Deliver seller order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/seller/{{wholesale_order_id}}/deliver", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "seller", "{{wholesale_order_id}}", "deliver" ] } }, "response": [] }, { "name": "Cancel seller order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-API-KEY", "value": "{{api_client_id}}" } ], "url": { "raw": "{{wholesale_base_url}}/orders/seller/{{wholesale_order_id}}/cancel", "host": [ "{{wholesale_base_url}}" ], "path": [ "orders", "seller", "{{wholesale_order_id}}", "cancel" ] } }, "response": [] } ] } ] } ] }