Add product to channel
Adds a product to a channel as an explicit member. The status field is computed synchronously from the channel's effective publishing rule. Re-adding an existing member is an idempotent refresh.
/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/products/{product_id}- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:PUT:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/products/{product_id}
Adds a product to a channel as an explicit member. The status field is computed synchronously from the channel's effective publishing rule. Re-adding an existing member is an idempotent refresh.
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:
PUT - Path:
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/products/\{product_id\} - Summary: Add product to channel
- Description: Adds a product to a channel as an explicit member. The status field is computed synchronously from the channel's effective publishing rule. Re-adding an existing member is an idempotent refresh.
- 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 |
|---|---|---|---|---|
| app_slug | path | Yes | string | App slug |
| team_slug | path | Yes | string | Team slug |
| channel_id | path | Yes | string | Channel ID |
| product_id | path | Yes | string | Product ID |
Request body
Not documented in the OpenAPI contract.
Responses
| Status | Description | Content |
|---|---|---|
| 200 | Membership added | application/json (object) |
| 400 | Invalid request | application/json (object) |
| 404 | Channel or product not found | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Channel Product 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 | - |
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):
{
"data": {
"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):
{
"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):
{
"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:
PUT - Path:
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/products/\{product_id\} - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Channels
- OpenAPI summary: Add product to channel