Bulk create collections
Creates multiple collections in a single request. Accepts up to 50 collections with optional parent relationships. Returns lists of successful and failed creations.
/api/v1/{team_slug}/{app_slug}/collections/bulk- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:POST:/api/v1/{team_slug}/{app_slug}/collections/bulk
Creates multiple collections in a single request. Accepts up to 50 collections with optional parent relationships. Returns lists of successful and failed creations.
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/bulk - Summary: Bulk create collections
- Description: Creates multiple collections in a single request. Accepts up to 50 collections with optional parent relationships. Returns lists of successful and failed creations.
- 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.
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: Collections data to create
- Content: application/json (object)
Bulk Create Collections Payload
| Property | Type | Required | Details |
|---|---|---|---|
collections | object[] | Yes | maxItems: 50 |
Collection Request
| Property | Type | Required | Details |
|---|---|---|---|
parent_id | string | No | - |
slug | string | Yes | - |
status | enum("active", "inactive", "draft") | Yes | - |
title | string | Yes | - |
Generated example (synthetic):
{
"collections": [
{
"parent_id": "string",
"slug": "string",
"status": "active",
"title": "string"
}
]
}Responses
| Status | Description | Content |
|---|---|---|
| 201 | Collections created successfully | application/json (object) |
| 400 | Invalid request | application/json (object) |
| 401 | Unauthorized access | application/json (object) |
| 500 | Internal server error | application/json (object) |
201 - object
Bulk Create 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 Create Collections
| Property | Type | Required | Details |
|---|---|---|---|
failed | object[] | No | - |
successful | object[] | No | - |
Bulk Create Collection Failed Creation
| Property | Type | Required | Details |
|---|---|---|---|
reason | string | No | - |
slug | string | No | - |
title | string | No | - |
Collection
| Property | Type | Required | Details |
|---|---|---|---|
children | object[] | No | - |
created_at | string | No | - |
id | string | No | - |
parent_id | string | No | - |
redirects | object[] | No | - |
slug | string | Yes | - |
status | enum("active", "inactive", "draft") | Yes | - |
title | string | No | - |
translations | object | No | - |
updated_at | string | No | - |
uri | string | No | - |
Generated example (synthetic):
{
"data": {
"failed": [
{
"reason": "string",
"slug": "string",
"title": "string"
}
],
"successful": [
{
"children": [],
"created_at": "string",
"id": "string",
"parent_id": "string",
"redirects": [],
"slug": "string",
"status": "active",
"title": "string",
"translations": {
"slug": null,
"title": null
},
"updated_at": "string",
"uri": "string"
}
]
},
"details": [
"string"
],
"success": false
}400 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"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):
{
"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):
{
"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/bulk - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Collections, Bulk
- OpenAPI summary: Bulk create collections