Skip to main content

Create product collection

POST /v2/product/collection

Creates a new product collection with a unique name for the specified tenant. The collection groups related product groups under one entity and includes metadata such as creation timestamps and associated products. Upon success, the API returns the full created collection including nested product group details.

Request Body​

{
    "name": "Cable Related Products",
    "productGroupIds": [
      "7e6c1fca-e735-4574-8b09-1ed83b8c0be1",
      "a569154b-1d2f-4008-ac72-f2fc744715a7"
    ]
  }

Response Example​

{
  "name": "Cable Related Products",
  "tenant": "6065a9eb6783e09eb34bb844",
  "productGroupIds": [
    "7e6c1fca-e735-4574-8b09-1ed83b8c0be1",
    "a569154b-1d2f-4008-ac72-f2fc744715a7"
  ],
  "created": "2025-07-03T10:00:00.000Z",
  "updated": "2025-07-03T10:00:00.000Z",
  "productGroups": [
    {
      "id": "7e6c1fca-e735-4574-8b09-1ed83b8c0be1",
      "group_id": "7e6c1fca-e735-4574-8b09-1ed83b8c0be1",
      "tenant": "6065a9eb6783e09eb34bb844",
      "name": "100-Pack Zip Ties Red",
      "status": {
        "active": true,
        "deleted": false
      },
      "products": [
        {
          "_id": "6835c4c4f1fe8456887efe06",
          "sku": "ZIT-ZIP-RED-0",
          "cost_price": 48,
          "price": 89.9
        }
      ]
    }
  ],
  "id": "6835c3c22d22c57cf7674a01"
}