Bulk add products to channel

Adds many products to a channel in one transaction. Each product's status is computed from the channel's effective publishing rule. Already-members are refreshed and returned in `successful`. Invalid IDs go in `failed` with a reason.

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

management-api:POST:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/products

Adds many products to a channel in one transaction. Each product's status is computed from the channel's effective publishing rule. Already-members are refreshed and returned in successful. Invalid IDs go in failed with a reason.

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\}/channels/\{channel_id\}/products
  • Summary: Bulk add products to channel
  • Description: Adds many products to a channel in one transaction. Each product's status is computed from the channel's effective publishing rule. Already-members are refreshed and returned in successful. Invalid IDs go in failed with a reason.
  • 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.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
channel_idpathYesstringChannel ID
Request bodyDocumented body
  • Required: Yes
  • Description: Product IDs to add
  • Content: application/json (object)

Bulk Add Channel Product Memberships Payload

PropertyTypeRequiredDetails
product_idsstring[]YesminItems: 1

Generated example (synthetic):

{
  "product_ids": [
    "string"
  ]
}
Responses4 statuses
StatusDescriptionContent
200Bulk add resultapplication/json (object)
400Invalid requestapplication/json (object)
404Channel not foundapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Bulk Channel Membership 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 Channel Membership
PropertyTypeRequiredDetails
failedobject[]No-
successfulobject[]No-
Bulk Channel Membership Failed
PropertyTypeRequiredDetails
idstringNo-
reasonstringNo-
Channel Product Membership
PropertyTypeRequiredDetails
channel_idstringNo-
created_atstringNo-
product_idstringNo-
statusstringNo-
status_updated_atstringNo-

Generated example (synthetic):

{
  "data": {
    "failed": [
      {
        "id": "string",
        "reason": "string"
      }
    ],
    "successful": [
      {
        "channel_id": "string",
        "created_at": "string",
        "product_id": "string",
        "status": "string",
        "status_updated_at": "string"
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

404 - 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\}/channels/\{channel_id\}/products
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Channels
  • OpenAPI summary: Bulk add products to channel

Bulk add products to channel

# Bulk add products to channel Adds many products to a channel in one transaction. Each product's status is computed from the channel's effective publishing rule. Already-members are refreshed and returned in `successful`. Invalid IDs go in `failed` with a reason.
POST /api/v1/{team_slug}/{app_slug}/channels/{channel_id}/products
Purpose

Adds many products to a channel in one transaction.

Required inputs

app_slug path team_slug path channel_id path

Primary response

200 ยท Bulk add result

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/products

## 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}/channels/{channel_id}/products` - Summary: Bulk add products to channel - Description: Adds many products to a channel in one transaction. Each product's status is computed from the channel's effective publishing rule. Already-members are refreshed and returned in `successful`. Invalid IDs go in `failed` with a reason. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/products` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | channel_id | path | Yes | string | Channel ID | ## Request body - Required: Yes - Description: Product IDs to add - Content: application/json (object) ### Bulk Add Channel Product Memberships Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `product_ids` | string[] | Yes | minItems: 1 | **Generated example (synthetic):** ```json { "product_ids": [ "string" ] } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Bulk add result | application/json (object) | | 400 | Invalid request | application/json (object) | | 404 | Channel not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Bulk Channel Membership 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 Channel Membership | Property | Type | Required | Details | | --- | --- | --- | --- | | `failed` | object[] | No | - | | `successful` | object[] | No | - | ##### Bulk Channel Membership Failed | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `reason` | string | No | - | ##### Channel Product Membership | Property | Type | Required | Details | | --- | --- | --- | --- | | `channel_id` | string | No | - | | `created_at` | string | No | - | | `product_id` | string | No | - | | `status` | string | No | - | | `status_updated_at` | string | No | - | **Generated example (synthetic):** ```json { "data": { "failed": [ { "id": "string", "reason": "string" } ], "successful": [ { "channel_id": "string", "created_at": "string", "product_id": "string", "status": "string", "status_updated_at": "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):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 404 - 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}/channels/{channel_id}/products` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/products` - OpenAPI tag: Channels - OpenAPI summary: Bulk add products to channel