Skip to main content

Add products to collection

PUT /v2/product/collection/products/add

Removes one or more product groups from multiple product collections. This operation updates the affected collections and returns the modified data, including metadata indicating which product groups were successfully removed and which were not found. Only collections belonging to the authenticated tenant can be modified.

Request Body

{
"collectionIds": [
"{{productCollectionId}}"
],
"productGroupIds": [
"f9e00b09-d749-4f33-943b-0d7736281260"
]
}

Response Example

{
"collections": [
{
"name": "Cable Related Products",
"tenant": "6065a9eb6783e09eb34bb844",
"productGroupIds": [
"a569154b-1d2f-4008-ac72-f2fc744715a7"
],
"created": "2025-07-03T10:00:00.000Z",
"updated": "2025-07-03T10:45:00.000Z",
"productGroups": [
{
"id": "a569154b-1d2f-4008-ac72-f2fc744715a7",
"group_id": "a569154b-1d2f-4008-ac72-f2fc744715a7",
"tenant": "6065a9eb6783e09eb34bb844",
"name": "100-Pack Zip Ties"
}
],
"id": "6835c3c22d22c57cf7674a01"
}
],
"metadata": {
"productGroupsRemoved": [
"7e6c1fca-e735-4574-8b09-1ed83b8c0be1"
],
"productGroupsNotFound": [
"nonexistent-id"
]
}
}