{
  "info": {
    "_postman_id": "ed085516-bd2e-536e-bd73-8c25c5961f77",
    "name": "POS GROVE POS API — Products",
    "description": "Products, variants, prices and stock. Reading needs pos.products or pos.pos; changes need pos.products. Cost prices are only shown with pos.products. API keys need the `pos` scope.\n\n**Setup**\n1. Set the collection variable `baseUrl` to your POS GROVE address followed by `/api/v1`.\n2. Either paste an API key (Online store → API & Webhooks) into `accessToken`, or run **Get an access token** (in the *Sign in* or *Authentication* folder): it signs in with a username and password and saves the token for you (valid 12 hours).\n3. Send any request. A test checks the `{ success }` envelope on every answer.\n\nAll responses use `{ success, message, data, meta }`; errors use `{ success: false, message, error: { code, details, requestId } }`. Lists accept `page`, `limit`, `sort` and `fields`.\n\nReference: https://posgrove.com/docs/pos-api",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{accessToken}}",
        "type": "string"
      }
    ]
  },
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "// POS GROVE APIs answer { success, message, data } (or { success: false, error, message }).",
          "pm.test(\"Response is JSON\", function () { pm.response.to.be.json; });",
          "pm.test(\"Envelope has a success flag\", function () {",
          "  var b = pm.response.json();",
          "  pm.expect(b).to.have.property(\"success\");",
          "  if (pm.response.code < 400) pm.expect(b.success).to.eql(true);",
          "});"
        ]
      }
    }
  ],
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://your-store.example.com/api/v1",
      "type": "string",
      "description": "Your POS GROVE address followed by /api/v1, e.g. https://shop.example.com/api/v1"
    },
    {
      "key": "accessToken",
      "value": "",
      "type": "string",
      "description": "An API key, or the token saved by the Get an access token request."
    }
  ],
  "item": [
    {
      "name": "Sign in",
      "description": "Run once: saves {{accessToken}} for the other requests (or paste an API key instead).",
      "item": [
        {
          "name": "Get an access token",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/auth/token",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "auth",
                "token"
              ]
            },
            "description": "Signs in with a username and password (and the 6-digit code when two-factor sign-in is on) and returns a bearer token valid for 12 hours. The token is shown only once. Five wrong passwords in a row disable the account, as on the sign-in page.\n\nNo authentication needed.\n\n`POST /auth/token` · operationId `auth.token`",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"username\": \"jane\",\n  \"password\": \"••••••••\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "auth": {
              "type": "noauth"
            }
          },
          "response": [
            {
              "name": "201 Success",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/auth/token",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "auth",
                    "token"
                  ]
                },
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"username\": \"jane\",\n  \"password\": \"••••••••\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Success",
              "code": 201,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json; charset=utf-8"
                }
              ],
              "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": {\n    \"token\": \"mtk_<token shown once>\",\n    \"tokenType\": \"Bearer\",\n    \"expiresAt\": \"2026-10-02T21:30:00.000Z\",\n    \"expiresIn\": 43200,\n    \"user\": {\n      \"id\": \"66f1c2a9e4b0a1b2c3d4e502\",\n      \"username\": \"jane\",\n      \"name\": \"Jane Doe\"\n    }\n  }\n}"
            }
          ],
          "event": [
            {
              "listen": "test",
              "script": {
                "type": "text/javascript",
                "exec": [
                  "var body = {};",
                  "try { body = pm.response.json(); } catch (e) {}",
                  "if (body && body.data && body.data.token) {",
                  "  pm.collectionVariables.set(\"accessToken\", body.data.token);",
                  "  if (pm.environment && pm.environment.has(\"accessToken\")) pm.environment.set(\"accessToken\", body.data.token);",
                  "  console.log(\"POS GROVE: access token saved to {{accessToken}} (valid until \" + body.data.expiresAt + \")\");",
                  "}",
                  "pm.test(\"Access token received\", function () { pm.expect(body.data && body.data.token).to.be.a(\"string\"); });"
                ]
              }
            }
          ]
        }
      ]
    },
    {
      "name": "List products",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/products",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "products"
          ],
          "query": [
            {
              "key": "page",
              "value": "1",
              "description": "Page number (starts at 1).",
              "disabled": true
            },
            {
              "key": "limit",
              "value": "25",
              "description": "Items per page (max 100).",
              "disabled": true
            },
            {
              "key": "sort",
              "value": "",
              "description": "Comma-separated fields; prefix with - for descending. Example: -createdAt,name",
              "disabled": true
            },
            {
              "key": "fields",
              "value": "",
              "description": "Comma-separated fields to return. Example: id,name,status",
              "disabled": true
            },
            {
              "key": "q",
              "value": "",
              "description": "Search text.",
              "disabled": true
            },
            {
              "key": "store",
              "value": "",
              "description": "\"all\" or a store id (needs pos.stores). Default: your store.",
              "disabled": true
            },
            {
              "key": "category",
              "value": "",
              "description": "",
              "disabled": true
            },
            {
              "key": "brand",
              "value": "",
              "description": "",
              "disabled": true
            },
            {
              "key": "status",
              "value": "",
              "description": "One of: active, inactive, discontinued, draft.",
              "disabled": true
            },
            {
              "key": "sku",
              "value": "",
              "description": "Exact product or variant SKU.",
              "disabled": true
            },
            {
              "key": "barcode",
              "value": "",
              "description": "",
              "disabled": true
            },
            {
              "key": "stock",
              "value": "",
              "description": "Products with at least one variant at this stock level. One of: out, low, in.",
              "disabled": true
            },
            {
              "key": "expiry",
              "value": "",
              "description": "\"expiring\" = within the configured window. One of: expired, expiring, none.",
              "disabled": true
            }
          ]
        },
        "description": "Permission: `pos.products` or `pos.pos`.\n\nScope: `pos:read`.\n\n`GET /products` · operationId `products.list`"
      },
      "response": [
        {
          "name": "200 Success",
          "originalRequest": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/products",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "products"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "description": "Page number (starts at 1).",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "25",
                  "description": "Items per page (max 100).",
                  "disabled": true
                },
                {
                  "key": "sort",
                  "value": "",
                  "description": "Comma-separated fields; prefix with - for descending. Example: -createdAt,name",
                  "disabled": true
                },
                {
                  "key": "fields",
                  "value": "",
                  "description": "Comma-separated fields to return. Example: id,name,status",
                  "disabled": true
                },
                {
                  "key": "q",
                  "value": "",
                  "description": "Search text.",
                  "disabled": true
                },
                {
                  "key": "store",
                  "value": "",
                  "description": "\"all\" or a store id (needs pos.stores). Default: your store.",
                  "disabled": true
                },
                {
                  "key": "category",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "brand",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "description": "One of: active, inactive, discontinued, draft.",
                  "disabled": true
                },
                {
                  "key": "sku",
                  "value": "",
                  "description": "Exact product or variant SKU.",
                  "disabled": true
                },
                {
                  "key": "barcode",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "stock",
                  "value": "",
                  "description": "Products with at least one variant at this stock level. One of: out, low, in.",
                  "disabled": true
                },
                {
                  "key": "expiry",
                  "value": "",
                  "description": "\"expiring\" = within the configured window. One of: expired, expiring, none.",
                  "disabled": true
                }
              ]
            }
          },
          "status": "Success",
          "code": 200,
          "_postman_previewlanguage": "json",
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": [\n    {\n      \"id\": \"66f1c2a9e4b0a1b2c3d4e503\",\n      \"name\": \"Rice 5kg\",\n      \"sku\": \"RICE5\",\n      \"barcode\": \"6151234567890\",\n      \"description\": \"Long-grain parboiled rice.\",\n      \"category\": \"Food\",\n      \"subcategory\": \"Grains\",\n      \"kitchenCategory\": \"\",\n      \"brand\": \"Golden Penny\",\n      \"status\": \"active\",\n      \"tags\": [\n        \"staple\"\n      ],\n      \"images\": [],\n      \"weight\": 5,\n      \"expiryDate\": \"2027-06-30\",\n      \"expiryStatus\": \"valid\",\n      \"storeId\": \"66f1c2a9e4b0a1b2c3d4e501\",\n      \"storeName\": \"Main Street\",\n      \"totalQuantity\": 42,\n      \"variants\": [\n        {\n          \"id\": \"66f1c2a9e4b0a1b2c3d4e504\",\n          \"variantId\": \"v_1a2b3c4d5e6f\",\n          \"name\": \"Rice 5kg\",\n          \"sku\": \"RICE5\",\n          \"price\": 6500,\n          \"compareAtPrice\": 7000,\n          \"currency\": \"NGN\",\n          \"quantity\": 42,\n          \"threshold\": 5,\n          \"stockLevel\": \"in\",\n          \"location\": \"Aisle 3\",\n          \"isActive\": true,\n          \"attributes\": {\n            \"size\": \"5kg\"\n          },\n          \"cost\": 5200\n        }\n      ],\n      \"createdAt\": \"2026-10-01T09:30:00.000Z\",\n      \"updatedAt\": \"2026-10-02T14:05:00.000Z\"\n    }\n  ]\n}"
        }
      ]
    },
    {
      "name": "Create a product",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/products",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "products"
          ]
        },
        "description": "Creates the product in your store (or `storeId`, with pos.stores). Images are added in the app.\n\nPermission: `pos.products`.\n\nScope: `pos:write`.\n\n`POST /products` · operationId `products.create`",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"name\": \"\",\n  \"sku\": \"\",\n  \"category\": \"\",\n  \"status\": \"active\",\n  \"variants\": [\n    {\n      \"price\": 0,\n      \"quantity\": 0\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": [
        {
          "name": "201 Success",
          "originalRequest": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/products",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "products"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"\",\n  \"sku\": \"\",\n  \"category\": \"\",\n  \"status\": \"active\",\n  \"variants\": [\n    {\n      \"price\": 0,\n      \"quantity\": 0\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "status": "Success",
          "code": 201,
          "_postman_previewlanguage": "json",
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": {\n    \"id\": \"66f1c2a9e4b0a1b2c3d4e503\",\n    \"name\": \"Rice 5kg\",\n    \"sku\": \"RICE5\",\n    \"barcode\": \"6151234567890\",\n    \"description\": \"Long-grain parboiled rice.\",\n    \"category\": \"Food\",\n    \"subcategory\": \"Grains\",\n    \"kitchenCategory\": \"\",\n    \"brand\": \"Golden Penny\",\n    \"status\": \"active\",\n    \"tags\": [\n      \"staple\"\n    ],\n    \"images\": [],\n    \"weight\": 5,\n    \"expiryDate\": \"2027-06-30\",\n    \"expiryStatus\": \"valid\",\n    \"storeId\": \"66f1c2a9e4b0a1b2c3d4e501\",\n    \"storeName\": \"Main Street\",\n    \"totalQuantity\": 42,\n    \"variants\": [\n      {\n        \"id\": \"66f1c2a9e4b0a1b2c3d4e504\",\n        \"variantId\": \"v_1a2b3c4d5e6f\",\n        \"name\": \"Rice 5kg\",\n        \"sku\": \"RICE5\",\n        \"price\": 6500,\n        \"compareAtPrice\": 7000,\n        \"currency\": \"NGN\",\n        \"quantity\": 42,\n        \"threshold\": 5,\n        \"stockLevel\": \"in\",\n        \"location\": \"Aisle 3\",\n        \"isActive\": true,\n        \"attributes\": {\n          \"size\": \"5kg\"\n        },\n        \"cost\": 5200\n      }\n    ],\n    \"createdAt\": \"2026-10-01T09:30:00.000Z\",\n    \"updatedAt\": \"2026-10-02T14:05:00.000Z\"\n  }\n}"
        }
      ]
    },
    {
      "name": "Get a product",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/products/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "products",
            ":id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "",
              "description": "Comma-separated fields to return. Example: id,name,status",
              "disabled": true
            }
          ],
          "variable": [
            {
              "key": "id",
              "value": "",
              "description": "Pattern: ^[a-f0-9]{24}$"
            }
          ]
        },
        "description": "Permission: `pos.products` or `pos.pos`.\n\nScope: `pos:read`.\n\n`GET /products/{id}` · operationId `products.get`"
      },
      "response": [
        {
          "name": "200 Success",
          "originalRequest": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/products/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "products",
                ":id"
              ],
              "query": [
                {
                  "key": "fields",
                  "value": "",
                  "description": "Comma-separated fields to return. Example: id,name,status",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Pattern: ^[a-f0-9]{24}$"
                }
              ]
            }
          },
          "status": "Success",
          "code": 200,
          "_postman_previewlanguage": "json",
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": {\n    \"id\": \"66f1c2a9e4b0a1b2c3d4e503\",\n    \"name\": \"Rice 5kg\",\n    \"sku\": \"RICE5\",\n    \"barcode\": \"6151234567890\",\n    \"description\": \"Long-grain parboiled rice.\",\n    \"category\": \"Food\",\n    \"subcategory\": \"Grains\",\n    \"kitchenCategory\": \"\",\n    \"brand\": \"Golden Penny\",\n    \"status\": \"active\",\n    \"tags\": [\n      \"staple\"\n    ],\n    \"images\": [],\n    \"weight\": 5,\n    \"expiryDate\": \"2027-06-30\",\n    \"expiryStatus\": \"valid\",\n    \"storeId\": \"66f1c2a9e4b0a1b2c3d4e501\",\n    \"storeName\": \"Main Street\",\n    \"totalQuantity\": 42,\n    \"variants\": [\n      {\n        \"id\": \"66f1c2a9e4b0a1b2c3d4e504\",\n        \"variantId\": \"v_1a2b3c4d5e6f\",\n        \"name\": \"Rice 5kg\",\n        \"sku\": \"RICE5\",\n        \"price\": 6500,\n        \"compareAtPrice\": 7000,\n        \"currency\": \"NGN\",\n        \"quantity\": 42,\n        \"threshold\": 5,\n        \"stockLevel\": \"in\",\n        \"location\": \"Aisle 3\",\n        \"isActive\": true,\n        \"attributes\": {\n          \"size\": \"5kg\"\n        },\n        \"cost\": 5200\n      }\n    ],\n    \"createdAt\": \"2026-10-01T09:30:00.000Z\",\n    \"updatedAt\": \"2026-10-02T14:05:00.000Z\"\n  }\n}"
        }
      ]
    },
    {
      "name": "Update product details",
      "request": {
        "method": "PATCH",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/products/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "products",
            ":id"
          ],
          "variable": [
            {
              "key": "id",
              "value": "",
              "description": "Pattern: ^[a-f0-9]{24}$"
            }
          ]
        },
        "description": "Send only the fields to change. Prices and stock are changed per variant (see below).\n\nPermission: `pos.products`.\n\nScope: `pos:write`.\n\n`PATCH /products/{id}` · operationId `products.update`",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"status\": \"active\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": [
        {
          "name": "200 Success",
          "originalRequest": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/products/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "products",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Pattern: ^[a-f0-9]{24}$"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"status\": \"active\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "status": "Success",
          "code": 200,
          "_postman_previewlanguage": "json",
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": {\n    \"id\": \"66f1c2a9e4b0a1b2c3d4e503\",\n    \"name\": \"Rice 5kg\",\n    \"sku\": \"RICE5\",\n    \"barcode\": \"6151234567890\",\n    \"description\": \"Long-grain parboiled rice.\",\n    \"category\": \"Food\",\n    \"subcategory\": \"Grains\",\n    \"kitchenCategory\": \"\",\n    \"brand\": \"Golden Penny\",\n    \"status\": \"active\",\n    \"tags\": [\n      \"staple\"\n    ],\n    \"images\": [],\n    \"weight\": 5,\n    \"expiryDate\": \"2027-06-30\",\n    \"expiryStatus\": \"valid\",\n    \"storeId\": \"66f1c2a9e4b0a1b2c3d4e501\",\n    \"storeName\": \"Main Street\",\n    \"totalQuantity\": 42,\n    \"variants\": [\n      {\n        \"id\": \"66f1c2a9e4b0a1b2c3d4e504\",\n        \"variantId\": \"v_1a2b3c4d5e6f\",\n        \"name\": \"Rice 5kg\",\n        \"sku\": \"RICE5\",\n        \"price\": 6500,\n        \"compareAtPrice\": 7000,\n        \"currency\": \"NGN\",\n        \"quantity\": 42,\n        \"threshold\": 5,\n        \"stockLevel\": \"in\",\n        \"location\": \"Aisle 3\",\n        \"isActive\": true,\n        \"attributes\": {\n          \"size\": \"5kg\"\n        },\n        \"cost\": 5200\n      }\n    ],\n    \"createdAt\": \"2026-10-01T09:30:00.000Z\",\n    \"updatedAt\": \"2026-10-02T14:05:00.000Z\"\n  }\n}"
        }
      ]
    },
    {
      "name": "Update a variant (price, threshold…)",
      "request": {
        "method": "PATCH",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/products/:id/variants/:variantId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "products",
            ":id",
            "variants",
            ":variantId"
          ],
          "variable": [
            {
              "key": "id",
              "value": "",
              "description": "Pattern: ^[a-f0-9]{24}$"
            },
            {
              "key": "variantId",
              "value": "",
              "description": ""
            }
          ]
        },
        "description": "`variantId` may be the variant id, its variantId or its SKU. Use the stock endpoint to change quantities.\n\nPermission: `pos.products`.\n\nScope: `pos:write`.\n\nBody fields (send only the ones you change):\n- `name` (string)\n- `price` (number)\n- `compareAtPrice` (number)\n- `cost` (number)\n- `threshold` (integer)\n- `location` (string)\n- `isActive` (boolean)\n\n`PATCH /products/{id}/variants/{variantId}` · operationId `products.variant.update`",
        "body": {
          "mode": "raw",
          "raw": "{}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": [
        {
          "name": "200 Success",
          "originalRequest": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/products/:id/variants/:variantId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "products",
                ":id",
                "variants",
                ":variantId"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Pattern: ^[a-f0-9]{24}$"
                },
                {
                  "key": "variantId",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "status": "Success",
          "code": 200,
          "_postman_previewlanguage": "json",
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": {\n    \"id\": \"66f1c2a9e4b0a1b2c3d4e503\",\n    \"name\": \"Rice 5kg\",\n    \"sku\": \"RICE5\",\n    \"barcode\": \"6151234567890\",\n    \"description\": \"Long-grain parboiled rice.\",\n    \"category\": \"Food\",\n    \"subcategory\": \"Grains\",\n    \"kitchenCategory\": \"\",\n    \"brand\": \"Golden Penny\",\n    \"status\": \"active\",\n    \"tags\": [\n      \"staple\"\n    ],\n    \"images\": [],\n    \"weight\": 5,\n    \"expiryDate\": \"2027-06-30\",\n    \"expiryStatus\": \"valid\",\n    \"storeId\": \"66f1c2a9e4b0a1b2c3d4e501\",\n    \"storeName\": \"Main Street\",\n    \"totalQuantity\": 42,\n    \"variants\": [\n      {\n        \"id\": \"66f1c2a9e4b0a1b2c3d4e504\",\n        \"variantId\": \"v_1a2b3c4d5e6f\",\n        \"name\": \"Rice 5kg\",\n        \"sku\": \"RICE5\",\n        \"price\": 6500,\n        \"compareAtPrice\": 7000,\n        \"currency\": \"NGN\",\n        \"quantity\": 42,\n        \"threshold\": 5,\n        \"stockLevel\": \"in\",\n        \"location\": \"Aisle 3\",\n        \"isActive\": true,\n        \"attributes\": {\n          \"size\": \"5kg\"\n        },\n        \"cost\": 5200\n      }\n    ],\n    \"createdAt\": \"2026-10-01T09:30:00.000Z\",\n    \"updatedAt\": \"2026-10-02T14:05:00.000Z\"\n  }\n}"
        }
      ]
    },
    {
      "name": "Adjust stock",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/products/:id/stock",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "products",
            ":id",
            "stock"
          ],
          "variable": [
            {
              "key": "id",
              "value": "",
              "description": "Pattern: ^[a-f0-9]{24}$"
            }
          ]
        },
        "description": "Either `adjustment` (e.g. 10 received, -2 damaged) or `quantity` (stock count). Stock never goes below zero; an adjustment that would is refused with 409. Low and out-of-stock alerts are raised as in the app.\n\nPermission: `pos.products`.\n\nScope: `pos:write`.\n\n`POST /products/{id}/stock` · operationId `products.stock`",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"reason\": \"Stock count\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": [
        {
          "name": "200 Success",
          "originalRequest": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/products/:id/stock",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "products",
                ":id",
                "stock"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Pattern: ^[a-f0-9]{24}$"
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"reason\": \"Stock count\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "status": "Success",
          "code": 200,
          "_postman_previewlanguage": "json",
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": {\n    \"productId\": \"66f1c2a9e4b0a1b2c3d4e503\",\n    \"variantId\": \"66f1c2a9e4b0a1b2c3d4e504\",\n    \"before\": 42,\n    \"after\": 52,\n    \"stockLevel\": \"in\"\n  }\n}"
        }
      ]
    },
    {
      "name": "Inventory alerts summary",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/inventory/summary",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "inventory",
            "summary"
          ],
          "query": [
            {
              "key": "store",
              "value": "",
              "description": "\"all\" or a store id (needs pos.stores). Default: your store.",
              "disabled": true
            },
            {
              "key": "days",
              "value": "",
              "description": "Expiring window in days.",
              "disabled": true
            }
          ]
        },
        "description": "Counts of expired, expiring, out-of-stock and low-stock items (as on the inventory dashboard).\n\nPermission: `pos.products` or `pos.pos`.\n\nScope: `pos:read`.\n\n`GET /inventory/summary` · operationId `inventory.summary`"
      },
      "response": [
        {
          "name": "200 Success",
          "originalRequest": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/inventory/summary",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "inventory",
                "summary"
              ],
              "query": [
                {
                  "key": "store",
                  "value": "",
                  "description": "\"all\" or a store id (needs pos.stores). Default: your store.",
                  "disabled": true
                },
                {
                  "key": "days",
                  "value": "",
                  "description": "Expiring window in days.",
                  "disabled": true
                }
              ]
            }
          },
          "status": "Success",
          "code": 200,
          "_postman_previewlanguage": "json",
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": {\n    \"days\": 30,\n    \"expired\": 1,\n    \"expiring\": 3,\n    \"out\": 2,\n    \"low\": 5,\n    \"stores\": [\n      \"66f1c2a9e4b0a1b2c3d4e501\"\n    ]\n  }\n}"
        }
      ]
    },
    {
      "name": "Inventory alert list",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/inventory/report?type=",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "inventory",
            "report"
          ],
          "query": [
            {
              "key": "type",
              "value": "",
              "description": "One of: expired, expiring, out, low.",
              "disabled": false
            },
            {
              "key": "days",
              "value": "",
              "description": "",
              "disabled": true
            },
            {
              "key": "page",
              "value": "1",
              "description": "Page number (starts at 1).",
              "disabled": true
            },
            {
              "key": "limit",
              "value": "25",
              "description": "Items per page (max 100).",
              "disabled": true
            },
            {
              "key": "q",
              "value": "",
              "description": "Search text.",
              "disabled": true
            },
            {
              "key": "store",
              "value": "",
              "description": "\"all\" or a store id (needs pos.stores). Default: your store.",
              "disabled": true
            }
          ]
        },
        "description": "One row per affected product (expiry) or variant (stock).\n\nPermission: `pos.products` or `pos.pos`.\n\nScope: `pos:read`.\n\n`GET /inventory/report` · operationId `inventory.report`"
      },
      "response": [
        {
          "name": "200 Success",
          "originalRequest": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/inventory/report?type=",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "inventory",
                "report"
              ],
              "query": [
                {
                  "key": "type",
                  "value": "",
                  "description": "One of: expired, expiring, out, low.",
                  "disabled": false
                },
                {
                  "key": "days",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "Page number (starts at 1).",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "25",
                  "description": "Items per page (max 100).",
                  "disabled": true
                },
                {
                  "key": "q",
                  "value": "",
                  "description": "Search text.",
                  "disabled": true
                },
                {
                  "key": "store",
                  "value": "",
                  "description": "\"all\" or a store id (needs pos.stores). Default: your store.",
                  "disabled": true
                }
              ]
            }
          },
          "status": "Success",
          "code": 200,
          "_postman_previewlanguage": "json",
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "body": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": [\n    {\n      \"productId\": \"66f1c2a9e4b0a1b2c3d4e503\",\n      \"name\": \"Rice 5kg\",\n      \"sku\": \"RICE5\",\n      \"category\": \"Food\",\n      \"variant\": \"Rice 5kg\",\n      \"variantSku\": \"RICE5\",\n      \"storeId\": \"66f1c2a9e4b0a1b2c3d4e501\",\n      \"storeName\": \"Main Street\",\n      \"status\": \"low\",\n      \"quantity\": 4,\n      \"threshold\": 5,\n      \"location\": \"Aisle 3\",\n      \"expiryDate\": \"2027-06-30T00:00:00.000Z\",\n      \"daysLeft\": 271,\n      \"type\": \"low\"\n    }\n  ]\n}"
        }
      ]
    }
  ]
}