Canto Product Channel Template Products API
Manage products associated with product channel templates.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/canto:canto-product-channel-template-products-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Canto PIM Product Channel Template Products API
description: Canto APIs enable seamless synchronization between the PIM + DAM and external systems that rely on accurate, up-to-date product content.
version: v1.0.1
servers:
- url: https://{tenantSubdomain}.{region}/api/v1/pim/
variables:
tenantSubdomain:
default: demo
region:
enum:
- canto.com
- canto.global
- canto.de
- au.canto.com
- ca.canto.com
default: canto.com
security:
- bearerAuth: []
tags:
- name: product_channel_template_products
description: Manage products associated with product channel templates.
paths:
/product_channel_templates/{product_channel_template_id}/products:
get:
tags:
- product_channel_template_products
summary: Get Product Channel Template Products
description: List products in a specific product channel template
operationId: get_api_v1_product_channel_templates_product_channel_template_id_products
parameters:
- name: product_channel_template_id
in: path
description: Product Channel Template ID
required: true
schema:
type: number
responses:
'200':
description: Successfully fetched Products
headers:
page-items:
description: Number of items per page
schema:
type: integer
link:
description: Standard link header defined in RFC 8228. Contains links for first, last, next, and prev pages with respective `rel` attributes
schema:
type: string
current-page:
description: Current page number
schema:
type: integer
total-count:
description: Total number of items
schema:
type: integer
total-pages:
description: Total number of pages
schema:
type: integer
content:
'*/*':
schema:
type: object
properties:
products:
type: array
description: Array of Products in this Channel Template
items:
type: object
properties:
id:
type: integer
description: Product ID
product_category_id:
type: integer
description: Product category ID
product_type_id:
type: integer
description: Product type ID
has_variants:
type: boolean
description: Whether the product has variants
dimension1_id:
type:
- integer
- 'null'
description: First dimension ID
dimension2_id:
type:
- integer
- 'null'
description: Second dimension ID
dimension3_id:
type:
- integer
- 'null'
description: Third dimension ID
created_at:
type: string
format: date-time
description: Creation timestamp
updated_at:
type: string
format: date-time
description: Last update timestamp
user_id:
type: string
description: User ID associated with the product
product_custom_attributes:
type: array
description: Array of general custom attributes for the product
items:
type: object
properties:
name:
type: string
description: Attribute name
value:
type: string
description: Attribute value
data_type:
type: string
description: Data type of the attribute
product_custom_attribute_id:
type: integer
description: Custom attribute ID
product_attribute_group_id:
type:
- integer
- 'null'
description: Attribute group ID
variants:
type: array
description: Array of product variants
items:
type: object
properties:
id:
type: integer
description: Variant ID
dimension_options:
type: object
description: Dimension options for the variant
properties:
primary:
type:
- object
- 'null'
properties:
name:
type: string
description: Dimension name
value:
type: string
description: Dimension value
dimension_id:
type: integer
description: Dimension ID
dimension_option_id:
type: integer
description: Dimension option ID
secondary:
type:
- object
- 'null'
properties:
name:
type: string
description: Dimension name
value:
type: string
description: Dimension value
dimension_id:
type: integer
description: Dimension ID
dimension_option_id:
type: integer
description: Dimension option ID
tertiary:
type:
- object
- 'null'
properties:
name:
type: string
description: Dimension name
value:
type: string
description: Dimension value
dimension_id:
type: integer
description: Dimension ID
dimension_option_id:
type: integer
description: Dimension option ID
additionalProperties: false
'400':
description: The request parameters were invalid
content: {}
'401':
description: User is not permitted to use the API or Authentication is invalid
content: {}
'404':
description: Product Channel Template ID not found
content: {}
'500':
description: Something went wrong
content: {}
post:
tags:
- product_channel_template_products
summary: Add a single Product to a Channel Template
description: Add a single Product to a Channel Template. If you wish to add multiple products, use the bulk endpoint instead.
operationId: post_api_v1_product_channel_templates_product_channel_template_id_products
parameters:
- name: product_channel_template_id
in: path
description: Product Channel Template ID
required: true
schema:
type: number
requestBody:
content:
application/json:
schema:
required:
- product_id
type: object
properties:
product_id:
type: integer
description: Product ID to add to the channel template
example: 1
required: true
responses:
'200':
description: Successfully added the product to the channel template
content:
'*/*':
schema:
type: object
properties:
id:
type: integer
description: Product ID
product_category_id:
type: integer
description: Product category ID
product_type_id:
type: integer
description: Product type ID
has_variants:
type: boolean
description: Whether the product has variants
dimension1_id:
type:
- integer
- 'null'
description: First dimension ID
dimension2_id:
type:
- integer
- 'null'
description: Second dimension ID
dimension3_id:
type:
- integer
- 'null'
description: Third dimension ID
created_at:
type: string
format: date-time
description: Creation timestamp
updated_at:
type: string
format: date-time
description: Last update timestamp
user_id:
type: string
description: User ID associated with the product
product_custom_attributes:
type: array
description: Array of general custom attributes for the product
items:
type: object
properties:
name:
type: string
description: Attribute name
value:
type: string
description: Attribute value
data_type:
type: string
description: Data type of the attribute
product_custom_attribute_id:
type: integer
description: Custom attribute ID
product_attribute_group_id:
type:
- integer
- 'null'
description: Attribute group ID
variants:
type: array
description: Array of product variants
items:
type: object
properties:
id:
type: integer
description: Variant ID
dimension_options:
type: object
description: Dimension options for the variant
properties:
primary:
type:
- object
- 'null'
properties:
name:
type: string
description: Dimension name
value:
type: string
description: Dimension value
dimension_id:
type: integer
description: Dimension ID
dimension_option_id:
type: integer
description: Dimension option ID
secondary:
type:
- object
- 'null'
properties:
name:
type: string
description: Dimension name
value:
type: string
description: Dimension value
dimension_id:
type: integer
description: Dimension ID
dimension_option_id:
type: integer
description: Dimension option ID
tertiary:
type:
- object
- 'null'
properties:
name:
type: string
description: Dimension name
value:
type: string
description: Dimension value
dimension_id:
type: integer
description: Dimension ID
dimension_option_id:
type: integer
description: Dimension option ID
additionalProperties: false
'400':
description: The request parameters were invalid
content: {}
'401':
description: User is not permitted to use the API or Authentication is invalid
content: {}
'404':
description: Product or Channel Template ID not found
content: {}
'422':
description: There was an error adding the product to the channel template
content: {}
'500':
description: Something went wrong
content: {}
/product_channel_templates/{product_channel_template_id}/products/{id}:
get:
tags:
- product_channel_template_products
summary: Get Product Channel Template Product
description: Retrieve a specific product from a product channel template
operationId: get_api_v1_product_channel_templates_product_channel_template_id_products_id
parameters:
- name: product_channel_template_id
in: path
description: Product Channel Template ID
required: true
schema:
type: number
- name: id
in: path
description: Product ID
required: true
schema:
type: number
- name: include_share_link
in: query
description: 'Include Share Link URL in response TODO: still defining'
required: false
schema:
type: boolean
responses:
'200':
description: Successfully fetched Product from Channel Template
content:
'*/*':
schema:
type: object
properties:
id:
type: integer
example: 1
product_category_id:
type: integer
example: 1
product_type_id:
type: integer
example: 1
has_variants:
type: boolean
example: true
dimension1_id:
type: integer
example: 1
dimension2_id:
type: integer
example: 2
dimension3_id:
type: integer
example: 3
created_at:
type: string
format: date-time
example: '2021-08-01T00:00:00.000Z'
updated_at:
type: string
format: date-time
example: '2021-08-01T00:00:00.000Z'
user_id:
type: string
example: 123e4567e89b12d3a456
product_custom_attributes:
type: array
items:
type: object
properties:
name:
type: string
value:
type:
- string
- 'null'
data_type:
type: string
product_custom_attribute_id:
type: integer
product_attribute_group_id:
type:
- integer
- 'null'
asset_ids:
type: array
items:
type: string
example:
- name: name
value: Product 1
data_type: text
product_custom_attribute_id: 1
product_attribute_group_id: null
- name: sku
value: SKU1
data_type: text
product_custom_attribute_id: 2
product_attribute_group_id: null
- name: Price
value: '10.00'
data_type: text
product_custom_attribute_id: 3
product_attribute_group_id: 1
- name: An Image
value: null
data_type: image
asset_ids:
- abc123
- def234
product_custom_attribute_id: 4
product_attribute_group_id: 2
variants:
type: array
items:
type: object
properties:
id:
type: integer
dimension_options:
type: object
properties:
primary:
type:
- object
- 'null'
properties:
name:
type: string
value:
type: string
dimension_id:
type: integer
dimension_option_id:
type: integer
secondary:
type:
- object
- 'null'
properties:
name:
type: string
value:
type: string
dimension_id:
type: integer
dimension_option_id:
type: integer
tertiary:
type:
- object
- 'null'
properties:
name:
type: string
value:
type: string
dimension_id:
type: integer
dimension_option_id:
type: integer
product_custom_attributes:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
data_type:
type: string
product_custom_attribute_id:
type: integer
product_attribute_group_id:
type:
- integer
- 'null'
example:
- id: 5
dimension_options:
primary:
name: Color
value: Red
dimension_id: 1
dimension_option_id: 1
secondary:
name: Size
value: Small
dimension_id: 2
dimension_option_id: 2
tertiary: null
product_custom_attributes:
- name: name
value: Product 1 - Red/Small
data_type: text
product_custom_attribute_id: 1
product_attribute_group_id: null
- name: sku
value: 1-red-small
data_type: text
product_custom_attribute_id: 2
product_attribute_group_id: null
- name: Price
value: '11.00'
data_type: text
product_custom_attribute_id: 3
product_attribute_group_id: 1
- id: 6
dimension_options:
primary:
name: Color
value: Blue
dimension_id: 1
dimension_option_id: 1
secondary:
name: Size
value: Large
dimension_id: 2
dimension_option_id: 2
tertiary: null
product_custom_attributes:
- name: name
value: Product 1 - Blue/Large
data_type: text
product_custom_attribute_id: 1
product_attribute_group_id: null
- name: sku
value: 1-blue-large
data_type: text
product_custom_attribute_id: 2
product_attribute_group_id: null
- name: Price
value: '12.00'
data_type: text
product_custom_attribute_id: 3
product_attribute_group_id: 1
product_assets:
type: array
items:
type: object
properties:
asset_id:
type: string
product_ids:
type: array
items:
type: integer
example:
- asset_id: e29b41d4a7166655440000
product_ids:
- 1
- 2
- 3
- 4
- 5
'400':
description: The request parameters were invalid
content: {}
'401':
description: User is not permitted to use the API or Authentication is invalid
content: {}
'404':
description: Product Channel Template or Product ID not found
content: {}
'500':
description: Something went wrong
content: {}
delete:
tags:
- product_channel_template_products
summary: Remove a single Product from a Channel Template
description: Remove a single Product from a Channel Template. If you wish to remove multiple products, use the bulk endpoint instead.
operationId: delete_api_v1_product_channel_templates_product_channel_template_id_products_id
parameters:
- name: product_channel_template_id
in: path
description: Product Channel Template ID
required: true
schema:
type: number
- name: id
in: path
description: Product ID
required: true
schema:
type: number
responses:
'204':
description: Successfully removed product from the channel template
content: {}
'400':
description: The request parameters were invalid
content: {}
'401':
description: User is not permitted to use the API or Authentication is invalid
content: {}
'404':
description: Product or Channel Template ID not found
content: {}
'422':
description: There was an error removing product from the channel template
content: {}
'500':
description: Something went wrong
content: {}
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: AccessToken
x-original-swagger-version: '2.0'