Skip to main content

Add Products To Category

PUT /v2/product/category/:id/products/add

Adds one or more products to an existing product group or category. Validates input, applies defaults (e.g., status flags and pricing), and returns the updated parent resource with embedded product details.

Headers​

  • Accept - Expected response format (Example: application/json, text/plain, */*)

Request Body​

[
      "a12debb4-3658-4b35-aaf7-d9c8ee58b9f9"
  ]

Response Example​

{
  "_id": "category-id-1",
  "name": "Example Category",
  "products": [
    {
      "_id": "product-id-1",
      "subscription": false,
      "services": [],
      "integrations": [],
      "categories": ["category-id-1"],
      "stock": 25,
      "shop_enabled": true,
      "status": {
        "active": true,
        "deleted": false
      },
      "sku": "EX-1001",
      "keys": [],
      "media": ["https://example.com/images/product-1.jpg"],
      "country": {
        "code": "NO",
        "_id": "country-id-1"
      },
      "currency": {
        "code": "NOK",
        "_id": "currency-id-1"
      },
      "tenant": "tenant-id-1",
      "type": 3,
      "name": "Example Product A",
      "description": "",
      "integration": [],
      "reference": null,
      "resell": false,
      "msp": false,
      "group_id": "group-id-1",
      "customInputs": [],
      "created": "2025-06-19T23:17:20.610Z",
      "updated": "2025-08-05T09:26:37.994Z",
      "consumption": {
        "metadata": {}
      },
      "distributor": {
        "_id": "distributor-id-1",
        "name": "Example Distributor",
        "tenant": "tenant-id-1",
        "active": true,
        "created": "2025-06-20T08:13:21.836Z",
        "updated": "2025-06-20T08:13:21.836Z"
      },
      "ingress": "",
      "managementLink": {
        "title": "",
        "url": ""
      },
      "stock_status": "In stock",
      "sales_channel": "Shop",
      "products": [
        {
          "subscription_term": 8640,
          "payment_period": 720,
          "amount": {
            "default": 1,
            "min": 0
          },
          "price": 1999.99,
          "_id": "price-id-1"
        }
      ]
    },
    {
      "_id": "product-id-2",
      "subscription": false,
      "services": [],
      "integrations": [],
      "categories": ["category-id-1"],
      "stock": 0,
      "shop_enabled": true,
      "status": {
        "active": true,
        "deleted": false
      },
      "sku": "EX-1002",
      "keys": [],
      "media": ["https://example.com/images/product-2.jpg"],
      "country": {
        "code": "NO",
        "_id": "country-id-2"
      },
      "currency": {
        "code": "NOK",
        "_id": "currency-id-2"
      },
      "tenant": "tenant-id-1",
      "type": 3,
      "name": "Example Product B",
      "description": "",
      "integration": [],
      "reference": null,
      "resell": false,
      "msp": false,
      "group_id": "group-id-2",
      "customInputs": [],
      "created": "2025-06-19T23:17:20.611Z",
      "updated": "2025-08-05T09:26:37.994Z",
      "stock_status": "Backorder",
      "sales_channel": "Shop",
      "products": [
        {
          "subscription_term": 8640,
          "payment_period": 720,
          "amount": {
            "default": 1,
            "min": 0
          },
          "price": 1299.00,
          "_id": "price-id-2"
        }
      ]
    }
  ]
}