{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.licenseshipper.com" } ], "info": { "name": "Licenseshipper API Documentation", "_postman_id": "e5276956-ba57-4d56-a893-4e595fa1473a", "description": "The LicenseShipper API enables developers and partners to securely manage, deliver, and track digital product licenses across multiple sales channels.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Activation Guides", "description": "Manage activation guides for your products.\n\nA product can have at most one guide.\nRecommended \"type\" values: text | html | pdf_url", "item": [ { "name": "List activation guides", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation-guides", "query": [ { "key": "q", "value": "%22Windows%22", "description": "Search in content (LIKE).", "disabled": false }, { "key": "product_id", "value": "12", "description": "Filter by product.", "disabled": false }, { "key": "type", "value": "html", "description": "Filter by type (text|html|pdf_url).", "disabled": false }, { "key": "per_page", "value": "25", "description": "Items per page (1..100, default 15).", "disabled": false }, { "key": "sort", "value": "created_at%2Cdesc", "description": "Sort \"field,dir\" where field in (id,created_at,updated_at).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/activation-guides?q=%22Windows%22&product_id=12&type=html&per_page=25&sort=created_at%2Cdesc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns guides for the authenticated user with filters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Activation guide list retrieved successfully.\",\n \"data\": {\n \"guides\": [\n { \"id\": 1, \"product_id\": 12, \"type\": \"html\", \"content\": \"

Steps...<\/p>\" }\n ]\n },\n \"meta\": { \"current_page\": 1, \"per_page\": 15, \"total\": 1, \"last_page\": 1 }\n}", "name": "" } ] }, { "name": "Create activation guide", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation-guides", "query": [], "raw": "{{baseUrl}}\/api\/activation-guides" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":12,\"type\":\"html\",\"content\":\"\\\"

Do this...<\\\/p>\\\"\"}" }, "description": "Creates a guide for a product owned by the user.\nEnforces one guide per product." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Activation guide created successfully.\",\n \"data\": { \"id\": 1, \"product_id\": 12, \"type\": \"html\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Show activation guide", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation-guides\/:guide_id", "query": [], "raw": "{{baseUrl}}\/api\/activation-guides\/:guide_id", "variable": [ { "id": "guide_id", "key": "guide_id", "value": "17", "description": "The ID of the guide." }, { "id": "guide", "key": "guide", "value": "17", "description": "Guide ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Activation guide details retrieved successfully.\",\n \"data\": { \"id\": 1, \"product_id\": 12, \"type\": \"html\", \"content\": \"

...<\/p>\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Update activation guide", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation-guides\/:guide_id", "query": [], "raw": "{{baseUrl}}\/api\/activation-guides\/:guide_id", "variable": [ { "id": "guide_id", "key": "guide_id", "value": "17", "description": "The ID of the guide." }, { "id": "guide", "key": "guide", "value": "17", "description": "Guide ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":17,\"type\":\"consequatur\",\"content\":\"consequatur\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Activation guide updated successfully.\",\n \"data\": { \"id\": 1, \"type\": \"html\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Update activation guide", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation-guides\/:guide_id", "query": [], "raw": "{{baseUrl}}\/api\/activation-guides\/:guide_id", "variable": [ { "id": "guide_id", "key": "guide_id", "value": "17", "description": "The ID of the guide." }, { "id": "guide", "key": "guide", "value": "17", "description": "Guide ID." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":17,\"type\":\"consequatur\",\"content\":\"consequatur\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Activation guide updated successfully.\",\n \"data\": { \"id\": 1, \"type\": \"html\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Delete activation guide", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activation-guides\/:guide_id", "query": [], "raw": "{{baseUrl}}\/api\/activation-guides\/:guide_id", "variable": [ { "id": "guide_id", "key": "guide_id", "value": "17", "description": "The ID of the guide." }, { "id": "guide", "key": "guide", "value": "17", "description": "Guide ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Activation guide deleted successfully.\",\n \"data\": [],\n \"meta\": []\n}", "name": "" } ] }, { "name": "Get activation guide by product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:product_id\/activation-guide", "query": [], "raw": "{{baseUrl}}\/api\/products\/:product_id\/activation-guide", "variable": [ { "id": "product_id", "key": "product_id", "value": "17", "description": "The ID of the product." }, { "id": "product", "key": "product", "value": "17", "description": "Product ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Convenience endpoint to fetch a guide via product ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Activation guide retrieved successfully.\",\n \"data\": { \"id\": 1, \"product_id\": 12, \"type\": \"html\" },\n \"meta\": []\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Activation guide not found.\",\n \"data\": [],\n \"meta\": []\n}", "name": "" } ] } ] }, { "name": "Licenses", "description": "API endpoints for managing license keys.\n\nStatus legend:\n- 0 = available\n- 1 = assigned\n- 2 = redeemed", "item": [ { "name": "List licenses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses", "query": [ { "key": "status", "value": "", "description": "Filter by status (0,1,2).", "disabled": true }, { "key": "product_id", "value": "12", "description": "Filter by product.", "disabled": false }, { "key": "supplier_id", "value": "3", "description": "Filter by supplier.", "disabled": false }, { "key": "order_email", "value": "user%40example.com", "description": "Filter by customer email (contains).", "disabled": false }, { "key": "order_id", "value": "100045", "description": "Filter by external order id (contains).", "disabled": false }, { "key": "key_ends", "value": "ABC123", "description": "Optional. Match last N chars of key (masked search).", "disabled": false }, { "key": "date_from", "value": "2025-08-01", "description": "date ISO date for created_at >=.", "disabled": false }, { "key": "date_to", "value": "2025-08-13", "description": "date ISO date for created_at ", "disabled": false }, { "key": "per_page", "value": "25", "description": "Items per page (1..100). Defaults to 15.", "disabled": false }, { "key": "sort", "value": "created_at%2Cdesc", "description": "Sort \"field,dir\" where field in (id, price, created_at, redeemed_at).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/licenses?status=&product_id=12&supplier_id=3&order_email=user%40example.com&order_id=100045&key_ends=ABC123&date_from=2025-08-01&date_to=2025-08-13&per_page=25&sort=created_at%2Cdesc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns licenses for the authenticated user with filtering, sorting, and pagination.\nLicense keys are masked in list results." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"License list retrieved successfully.\",\n \"data\": {\n \"licenses\": [\n {\n \"id\": 1,\n \"product_id\": 12,\n \"supplier_id\": 3,\n \"masked_key\": \"ABCD\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u20221234\",\n \"price\": \"9.99\",\n \"status\": 0,\n \"order_id\": null,\n \"order_email\": null,\n \"source\": \"Manual\",\n \"redeemed_at\": null,\n \"created_at\": \"2025-08-13T10:20:00Z\"\n }\n ]\n },\n \"meta\": { \"current_page\": 1, \"per_page\": 15, \"total\": 1, \"last_page\": 1 }\n}", "name": "" } ] }, { "name": "Create license(s)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses", "query": [], "raw": "{{baseUrl}}\/api\/licenses" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":17,\"supplier_id\":17,\"key\":\"consequatur\",\"price\":9.99,\"source\":\"consequatur\",\"status\":17,\"items\":[{\"product_id\":1,\"key\":\"ABC\",\"price\":0}]}" }, "description": "Create a single license or bulk create using \"items\".\nWhen bulk, each item must contain at least product_id and key." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"License(s) created successfully.\",\n \"data\": {\n \"created\": [\n { \"id\": 10, \"masked_key\": \"ABCD\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u20221234\", \"status\": 0 }\n ]\n },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Show license (full key)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses\/:license_id", "query": [], "raw": "{{baseUrl}}\/api\/licenses\/:license_id", "variable": [ { "id": "license_id", "key": "license_id", "value": "17", "description": "The ID of the license." }, { "id": "license", "key": "license", "value": "17", "description": "The license ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a single license. The **full key** is included here." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"License details retrieved successfully.\",\n \"data\": {\n \"id\": 1,\n \"product_id\": 12,\n \"supplier_id\": 3,\n \"key\": \"FULL-KEY-VALUE-HERE\",\n \"price\": \"9.99\",\n \"status\": 0,\n \"order_id\": null,\n \"order_email\": null,\n \"source\": \"Manual\",\n \"redeemed_at\": null\n },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Update license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses\/:license_id", "query": [], "raw": "{{baseUrl}}\/api\/licenses\/:license_id", "variable": [ { "id": "license_id", "key": "license_id", "value": "17", "description": "The ID of the license." }, { "id": "license", "key": "license", "value": "17", "description": "The license ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":17,\"supplier_id\":17,\"key\":\"consequatur\",\"price\":11613.31890586,\"status\":17,\"order_id\":\"consequatur\",\"order_email\":\"qkunze@example.com\",\"source\":\"consequatur\",\"redeemed_at\":\"consequatur\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"License updated successfully.\",\n \"data\": { \"id\": 1, \"status\": 1 },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Update license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses\/:license_id", "query": [], "raw": "{{baseUrl}}\/api\/licenses\/:license_id", "variable": [ { "id": "license_id", "key": "license_id", "value": "17", "description": "The ID of the license." }, { "id": "license", "key": "license", "value": "17", "description": "The license ID." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":17,\"supplier_id\":17,\"key\":\"consequatur\",\"price\":11613.31890586,\"status\":17,\"order_id\":\"consequatur\",\"order_email\":\"qkunze@example.com\",\"source\":\"consequatur\",\"redeemed_at\":\"consequatur\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"License updated successfully.\",\n \"data\": { \"id\": 1, \"status\": 1 },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Delete license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses\/:license_id", "query": [], "raw": "{{baseUrl}}\/api\/licenses\/:license_id", "variable": [ { "id": "license_id", "key": "license_id", "value": "17", "description": "The ID of the license." }, { "id": "license", "key": "license", "value": "17", "description": "The license ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"License deleted successfully.\",\n \"data\": [],\n \"meta\": []\n}", "name": "" } ] }, { "name": "Assign a license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses\/:license_id\/assign", "query": [], "raw": "{{baseUrl}}\/api\/licenses\/:license_id\/assign", "variable": [ { "id": "license_id", "key": "license_id", "value": "17", "description": "The ID of the license." }, { "id": "license", "key": "license", "value": "17", "description": "The license ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"order_id\":\"consequatur\",\"order_email\":\"qkunze@example.com\",\"source\":\"WooCommerce\"}" }, "description": "Transition to **assigned** (1). Typically used when linking a license to an order." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"License assigned successfully.\",\n \"data\": { \"id\": 1, \"status\": 1, \"order_id\": \"100045\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Redeem a license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses\/:license_id\/redeem", "query": [], "raw": "{{baseUrl}}\/api\/licenses\/:license_id\/redeem", "variable": [ { "id": "license_id", "key": "license_id", "value": "17", "description": "The ID of the license." }, { "id": "license", "key": "license", "value": "17", "description": "The license ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"redeemed_at\":\"consequatur\"}" }, "description": "Transition to **redeemed** (2) and set `redeemed_at`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"License redeemed successfully.\",\n \"data\": { \"id\": 1, \"status\": 2, \"redeemed_at\": \"2025-08-13T11:12:13Z\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Unassign a license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/licenses\/:license_id\/unassign", "query": [], "raw": "{{baseUrl}}\/api\/licenses\/:license_id\/unassign", "variable": [ { "id": "license_id", "key": "license_id", "value": "17", "description": "The ID of the license." }, { "id": "license", "key": "license", "value": "17", "description": "The license ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Reset a license back to **available** (0). Clears order fields and `redeemed_at`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"License unassigned successfully.\",\n \"data\": { \"id\": 1, \"status\": 0 },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Fetch licenses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/license\/fetch", "query": [], "raw": "{{baseUrl}}\/api\/license\/fetch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sku\":\"WIN11-PRO-KEY\",\"quantity\":2,\"order_id\":\"WC-102938\",\"order_email\":\"buyer@example.com\",\"source\":\"woocommerce\"}" }, "description": "Assigns license keys for a given product SKU if the subscription is valid,\nblacklist rules pass, and stock is available." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"All licenses assigned successfully.\",\n \"data\": {\n \"product\": {\n \"name\": \"Windows 11 Pro\",\n \"sku\": \"WIN11-PRO-KEY\",\n \"download_link\": \"https:\/\/example.com\/dl\",\n \"activation_guide\": \"https:\/\/app.example.com\/storage\/temp-guides\/guide.pdf\"\n },\n \"licenses\": [\n {\"license_id\": 1, \"key\": \"AAAA-BBBB-CCCC-DDDD\", \"price\": 14.99}\n ]\n },\n \"meta\": { \"delivered_total\": 1 }\n}", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"This order has already received licenses.\",\n \"meta\": { \"already_delivered\": 1 }\n}", "name": "Already delivered" }, { "header": [], "code": 402, "body": "{ \"success\": false, \"message\": \"Subscription missing\" }", "name": "Subscription missing" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Request blocked by Blacklist Manager.\",\n \"meta\": { \"block_id\": 12, \"scope\": \"global\" }\n}", "name": "Blacklisted" }, { "header": [], "code": 404, "body": "{ \"success\": false, \"message\": \"Product not found or unauthorized.\" }", "name": "Product not found" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed.\",\n \"errors\": { \"sku\": [\"The sku field is required.\"] }\n}", "name": "Validation error" }, { "header": [], "code": 429, "body": "{ \"success\": false, \"message\": \"Monthly quota reached. Upgrade plan or wait until next month.\" }", "name": "Monthly quota reached" } ] } ] }, { "name": "Products", "description": "API endpoints for managing your products.", "item": [ { "name": "List products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products", "query": [ { "key": "q", "value": "consequatur", "description": "Optional. Search term for name or SKU.", "disabled": false }, { "key": "active", "value": "", "description": "Optional. Filter by active status (1 or 0).", "disabled": true }, { "key": "sort", "value": "consequatur", "description": "Optional. Sort field and direction (e.g. name,asc).", "disabled": false }, { "key": "per_page", "value": "17", "description": "Optional. Results per page (default: 15).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/products?q=consequatur&active=&sort=consequatur&per_page=17" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the authenticated user's active products." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Product list retrieved successfully.\",\n \"data\": {\n \"products\": [\n { \"id\": 1, \"name\": \"Windows 11 Pro\", \"sku\": \"WIN11-PRO-KEY\" }\n ]\n },\n \"meta\": { \"count\": 1 }\n}", "name": "" } ] }, { "name": "Create product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products", "query": [], "raw": "{{baseUrl}}\/api\/products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"consequatur\",\"sku\":\"consequatur\",\"download_link\":\"consequatur\",\"active\":false}" }, "description": "Adds a new product for the authenticated user." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Product created successfully.\",\n \"data\": { \"id\": 1, \"name\": \"Windows 11 Pro\", \"sku\": \"WIN11-PRO-KEY\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Show product details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:product_id", "query": [], "raw": "{{baseUrl}}\/api\/products\/:product_id", "variable": [ { "id": "product_id", "key": "product_id", "value": "17", "description": "The ID of the product." }, { "id": "id", "key": "id", "value": "17", "description": "The ID of the product." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Displays full product information by ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Product details retrieved successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Windows 11 Pro\",\n \"sku\": \"WIN11-PRO-KEY\",\n \"download_link\": \"https:\/\/example.com\/file.zip\",\n \"active\": true\n },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Update product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:product_id", "query": [], "raw": "{{baseUrl}}\/api\/products\/:product_id", "variable": [ { "id": "product_id", "key": "product_id", "value": "17", "description": "The ID of the product." }, { "id": "id", "key": "id", "value": "17", "description": "The ID of the product." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"consequatur\",\"sku\":\"consequatur\",\"download_link\":\"consequatur\",\"active\":false}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Product updated successfully.\",\n \"data\": { \"id\": 1, \"name\": \"Windows 11 Pro\", \"sku\": \"WIN11-PRO-KEY\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Update product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:product_id", "query": [], "raw": "{{baseUrl}}\/api\/products\/:product_id", "variable": [ { "id": "product_id", "key": "product_id", "value": "17", "description": "The ID of the product." }, { "id": "id", "key": "id", "value": "17", "description": "The ID of the product." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"consequatur\",\"sku\":\"consequatur\",\"download_link\":\"consequatur\",\"active\":false}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Product updated successfully.\",\n \"data\": { \"id\": 1, \"name\": \"Windows 11 Pro\", \"sku\": \"WIN11-PRO-KEY\" },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Delete product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:product_id", "query": [], "raw": "{{baseUrl}}\/api\/products\/:product_id", "variable": [ { "id": "product_id", "key": "product_id", "value": "17", "description": "The ID of the product." }, { "id": "id", "key": "id", "value": "17", "description": "The ID of the product." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Product deleted successfully.\",\n \"data\": [],\n \"meta\": []\n}", "name": "" } ] }, { "name": "List licenses for a product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:product_id\/licenses", "query": [ { "key": "status", "value": "", "description": "Optional. Filter by status (0=available, 1=assigned, 2=redeemed).", "disabled": true }, { "key": "per_page", "value": "25", "description": "Optional. Items per page (1..100, default 15).", "disabled": false }, { "key": "sort", "value": "created_at%2Cdesc", "description": "Optional. Sort \"field,dir\" where field in (id,price,created_at,redeemed_at).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/products\/:product_id\/licenses?status=&per_page=25&sort=created_at%2Cdesc", "variable": [ { "id": "product_id", "key": "product_id", "value": "17", "description": "The ID of the product." }, { "id": "product", "key": "product", "value": "12", "description": "The product ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns licenses linked to a specific product you own.\nLicense keys are masked in the list for security.\nUse the `GET \/licenses\/{license}` endpoint to see the full key." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Product licenses retrieved successfully.\",\n \"data\": {\n \"licenses\": [\n {\n \"id\": 101,\n \"masked_key\": \"ABCD\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u20221234\",\n \"price\": \"9.99\",\n \"status\": 0,\n \"order_id\": null,\n \"order_email\": null,\n \"source\": \"Manual\",\n \"redeemed_at\": null,\n \"created_at\": \"2025-08-13T10:20:00Z\"\n }\n ]\n },\n \"meta\": {\n \"counts\": { \"total\": 10, \"available\": 6, \"assigned\": 3, \"redeemed\": 1 },\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 10,\n \"last_page\": 1\n }\n}", "name": "" } ] }, { "name": "List licenses by SKU", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/sku\/:sku\/licenses", "query": [ { "key": "status", "value": "", "description": "Optional. Filter by status (0=available, 1=assigned, 2=redeemed).", "disabled": true }, { "key": "per_page", "value": "25", "description": "Optional. Items per page (1..100, default 15).", "disabled": false }, { "key": "sort", "value": "created_at%2Cdesc", "description": "Optional. Sort \"field,dir\" where field in (id,price,created_at,redeemed_at).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/products\/sku\/:sku\/licenses?status=&per_page=25&sort=created_at%2Cdesc", "variable": [ { "id": "sku", "key": "sku", "value": "WIN11-PRO-KEY", "description": "The product SKU." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns licenses for a product you own, looked up by SKU.\nLicense keys are masked in the list for security." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Product licenses (by SKU) retrieved successfully.\",\n \"data\": { \"licenses\": [] },\n \"meta\": { \"counts\": { \"total\": 0, \"available\": 0, \"assigned\": 0, \"redeemed\": 0 }, \"current_page\": 1, \"per_page\": 15, \"total\": 0, \"last_page\": 1 }\n}", "name": "" } ] } ] }, { "name": "Suppliers", "description": "API endpoints for managing suppliers.", "item": [ { "name": "List suppliers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers", "query": [ { "key": "q", "value": "%22Acme%22", "description": "Optional. Search in name or contact.", "disabled": false }, { "key": "status", "value": "1", "description": "Optional. 1 or 0.", "disabled": false }, { "key": "sort", "value": "name%2Casc", "description": "Optional. \"field,dir\" where field in (id,name,created_at).", "disabled": false }, { "key": "per_page", "value": "25", "description": "Optional. 1..100 (default 15).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/suppliers?q=%22Acme%22&status=1&sort=name%2Casc&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns suppliers belonging to the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Supplier list retrieved successfully.\",\n \"data\": {\n \"suppliers\": [\n { \"id\": 1, \"name\": \"Acme Keys\", \"contact\": \"sales@acme.tld\", \"status\": true }\n ]\n },\n \"meta\": { \"current_page\": 1, \"per_page\": 15, \"total\": 1, \"last_page\": 1, \"sort\": [\"id\",\"desc\"] }\n}", "name": "" } ] }, { "name": "Create supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers", "query": [], "raw": "{{baseUrl}}\/api\/suppliers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Acme Keys\",\"contact\":\"sales@acme.tld\",\"status\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Supplier created successfully.\",\n \"data\": { \"id\": 1, \"name\": \"Acme Keys\", \"contact\": \"sales@acme.tld\", \"status\": true },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Show supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers\/:supplier_id", "query": [], "raw": "{{baseUrl}}\/api\/suppliers\/:supplier_id", "variable": [ { "id": "supplier_id", "key": "supplier_id", "value": "17", "description": "The ID of the supplier." }, { "id": "supplier", "key": "supplier", "value": "17", "description": "Supplier ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a supplier and quick license counts." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Supplier details retrieved successfully.\",\n \"data\": {\n \"id\": 1, \"name\": \"Acme Keys\", \"contact\": \"sales@acme.tld\", \"status\": true,\n \"license_counts\": { \"total\": 20, \"available\": 15, \"assigned\": 3, \"redeemed\": 2 }\n },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Update supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers\/:supplier_id", "query": [], "raw": "{{baseUrl}}\/api\/suppliers\/:supplier_id", "variable": [ { "id": "supplier_id", "key": "supplier_id", "value": "17", "description": "The ID of the supplier." }, { "id": "supplier", "key": "supplier", "value": "17", "description": "Supplier ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"consequatur\",\"contact\":\"consequatur\",\"status\":false}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Supplier updated successfully.\",\n \"data\": { \"id\": 1, \"name\": \"Acme Keys\", \"status\": true },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Update supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers\/:supplier_id", "query": [], "raw": "{{baseUrl}}\/api\/suppliers\/:supplier_id", "variable": [ { "id": "supplier_id", "key": "supplier_id", "value": "17", "description": "The ID of the supplier." }, { "id": "supplier", "key": "supplier", "value": "17", "description": "Supplier ID." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"consequatur\",\"contact\":\"consequatur\",\"status\":false}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Supplier updated successfully.\",\n \"data\": { \"id\": 1, \"name\": \"Acme Keys\", \"status\": true },\n \"meta\": []\n}", "name": "" } ] }, { "name": "Delete supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers\/:supplier_id", "query": [], "raw": "{{baseUrl}}\/api\/suppliers\/:supplier_id", "variable": [ { "id": "supplier_id", "key": "supplier_id", "value": "17", "description": "The ID of the supplier." }, { "id": "supplier", "key": "supplier", "value": "17", "description": "Supplier ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Note: Existing licenses referencing this supplier will be deleted\nonly if your foreign key is `onDelete('cascade')` on `licenses.supplier_id`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Supplier deleted successfully.\",\n \"data\": [],\n \"meta\": []\n}", "name": "" } ] }, { "name": "Toggle supplier status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers\/:supplier_id\/toggle", "query": [], "raw": "{{baseUrl}}\/api\/suppliers\/:supplier_id\/toggle", "variable": [ { "id": "supplier_id", "key": "supplier_id", "value": "17", "description": "The ID of the supplier." }, { "id": "supplier", "key": "supplier", "value": "17", "description": "Supplier ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Flips `status` true\/false." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Supplier status toggled successfully.\",\n \"data\": { \"id\": 1, \"status\": false },\n \"meta\": []\n}", "name": "" } ] } ] }, { "name": "Utility", "description": "", "item": [ { "name": "Ping (health check)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ping", "query": [], "raw": "{{baseUrl}}\/api\/ping" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lightweight endpoint to verify API availability and clock sync.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Ping successful.\",\n \"data\": { \"server_time\": \"2025-08-13 17:20:33\" },\n \"meta\": { \"author\": \"LicenseShipper API\" }\n}", "name": "" } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "in", "value": "header", "type": "string" }, { "key": "key", "value": "X-API-KEY", "type": "string" } ] } }