Skip to main content

Restore product collection

POST /v2/product/collection/restore

Restores one or more soft-deleted product collections. If no collection IDs are provided, the most recently deleted collection is restored. When a restored collection’s original name conflicts with an existing collection, the restored collection’s name is suffixed with the last 8 characters of its ID in parentheses (e.g., "Hardware Collection (0000ef12)").

Request Body​

{
    "collectionIds": ["{{productCollectionId}}"]
  }

Response Example​

{
  "collections": [
    {
      "name": "Cable Related Products",
      "tenant": "example-tenant-id",
      "productGroupIds": [
        "group-id-1",
        "group-id-2"
      ],
      "created": "2025-07-03T10:00:00.000Z",
      "updated": "2025-07-03T11:00:00.000Z",
      "productGroups": [
        {
          "id": "group-id-1",
          "group_id": "group-id-1",
          "tenant": "example-tenant-id",
          "name": "Example Product Group A"
        }
      ],
      "id": "00000000000000000000abcd"
    },
    {
      "name": "Hardware Collection (0000ef12)",
      "tenant": "example-tenant-id",
      "productGroupIds": [],
      "created": "2025-07-03T09:00:00.000Z",
      "updated": "2025-07-03T11:00:00.000Z",
      "productGroups": [],
      "id": "00000000000000000000ef12"
    }
  ],
  "metadata": {
    "restored": {
      "00000000000000000000abcd": true,
      "00000000000000000000ef12": true,
      "missing-id-1": false
    },
    "restoredCount": 2,
    "notRestoredCount": 1
  }
}