post
https://{subdomain}.myshoplaza.com/openapi/2025-06/collects/batch
Requireswrite_collectionaccess scope. More access scope
The Batch Create Collect API allows developers add multiple products to a collection.
This API is especially useful for:
- Bulk adding products to collections
- Synchronizing collection contents
Request Parameters
Public Request Parameters
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
collection_id | string | Yes | Unique collection identifiers | "coll_12345678" |
product_ids | array[string] | Yes | Array of product IDs to add | ["prod_123","prod_456"] |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | 200 | Error code (200 indicates success) |
message | string | Success | Error message |
data | object | {...} |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |