Bulk add products to collections

Adds multiple products to multiple collections in a single request. Accepts up to 50 collection-product relationships. Returns lists of successful and failed additions.

POST/api/v1/{team_slug}/{app_slug}/collections/products/bulk
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/collections/products/bulk

Adds multiple products to multiple collections in a single request. Accepts up to 50 collection-product relationships. Returns lists of successful and failed additions.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/collections/products/bulk
  • Summary: Bulk add products to collections
  • Description: Adds multiple products to multiple collections in a single request. Accepts up to 50 collection-product relationships. Returns lists of successful and failed additions.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
team_slugpathYesstringTeam slug
app_slugpathYesstringApp slug
Request bodyDocumented body
  • Required: Yes
  • Description: Product and collection relationships to create
  • Content: application/json (object)

Bulk Modify Collection Products Payload

PropertyTypeRequiredDetails
itemsobject[]YesmaxItems: 50

Bulk Collection Product Relationship Item

PropertyTypeRequiredDetails
collection_idstringYes-
product_idsstring[]YesminItems: 1

Generated example (synthetic):

{
  "items": [
    {
      "collection_id": "string",
      "product_ids": [
        "string"
      ]
    }
  ]
}
Responses4 statuses
StatusDescriptionContent
200Products added to collections successfullyapplication/json (object)
400Invalid requestapplication/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Bulk Add Products To Collections Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Bulk Add Products To Collections
PropertyTypeRequiredDetails
failedobject[]No-
successfulobject[]No-
Bulk Collection Product Failed Op
PropertyTypeRequiredDetails
collection_idstringNo-
product_idstringNo-
reasonstringNo-
Bulk Collection Product Relationship Item
PropertyTypeRequiredDetails
collection_idstringYes-
product_idsstring[]YesminItems: 1

Generated example (synthetic):

{
  "data": {
    "failed": [
      {
        "collection_id": "string",
        "product_id": "string",
        "reason": "string"
      }
    ],
    "successful": [
      {
        "collection_id": "string",
        "product_ids": []
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/collections/products/bulk
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Collections, Bulk
  • OpenAPI summary: Bulk add products to collections

Bulk add products to collections

# Bulk add products to collections Adds multiple products to multiple collections in a single request. Accepts up to 50 collection-product relationships. Returns lists of successful and failed additions.
POST /api/v1/{team_slug}/{app_slug}/collections/products/bulk
Purpose

Adds multiple products to multiple collections in a single request.

Required inputs

team_slug path app_slug path

Primary response

200 ยท Products added to collections successfully

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/collections/products/bulk

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/collections/products/bulk` - Summary: Bulk add products to collections - Description: Adds multiple products to multiple collections in a single request. Accepts up to 50 collection-product relationships. Returns lists of successful and failed additions. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/collections/products/bulk` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | team_slug | path | Yes | string | Team slug | | app_slug | path | Yes | string | App slug | ## Request body - Required: Yes - Description: Product and collection relationships to create - Content: application/json (object) ### Bulk Modify Collection Products Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `items` | object[] | Yes | maxItems: 50 | #### Bulk Collection Product Relationship Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `collection_id` | string | Yes | - | | `product_ids` | string[] | Yes | minItems: 1 | **Generated example (synthetic):** ```json { "items": [ { "collection_id": "string", "product_ids": [ "string" ] } ] } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Products added to collections successfully | application/json (object) | | 400 | Invalid request | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Bulk Add Products To Collections Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Bulk Add Products To Collections | Property | Type | Required | Details | | --- | --- | --- | --- | | `failed` | object[] | No | - | | `successful` | object[] | No | - | ##### Bulk Collection Product Failed Op | Property | Type | Required | Details | | --- | --- | --- | --- | | `collection_id` | string | No | - | | `product_id` | string | No | - | | `reason` | string | No | - | ##### Bulk Collection Product Relationship Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `collection_id` | string | Yes | - | | `product_ids` | string[] | Yes | minItems: 1 | **Generated example (synthetic):** ```json { "data": { "failed": [ { "collection_id": "string", "product_id": "string", "reason": "string" } ], "successful": [ { "collection_id": "string", "product_ids": [] } ] }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/collections/products/bulk` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/collections/products/bulk` - OpenAPI tag: Collections, Bulk - OpenAPI summary: Bulk add products to collections