Canto bulk_products_catalogs API
Perform bulk products operation on a Product Catalog These endpoints allow you to add or remove products that are associated with a specific product catalog in bulk.
OpenAPI Specification
openapi: 3.0.1
info:
title: Canto PIM bulk_products_catalogs API
description: "\n[Canto APIs](https://api.canto.com) enable seamless synchronization between the PIM + DAM and external systems that rely on accurate, up-to-date product content. \nThe API outlined here provides programmatic access to Canto’s Product Hub (PIM). The Product Hub API allows authorized systems to create, retrieve, update, and manage rich product data for use across digital channels, e-commerce platforms, and other target or source systems. \n \n<b>Key Capabilities</b><br />\nThe Canto Product Hub API enables full product data management:\n1. Product Record Management: Create, read, update, and delete product entries including structured metadata, taxonomy, categories, and references.\n2. Attribute & Schema Configuration: Access and manage custom product attributes and classification structures\n3. Webhooks: Trigger updates or publish product datasets to downstream systems and integration pipelines.\n \n<b>API Design</b>\n- The PIM API adheres to <b>RESTful principles</b>, supporting standard HTTP methods (GET, POST, PUT, PATCH, DELETE).\n- JSON is the default payload format for both requests and responses.\n\n<b>HTTP Status Code Conventions</b><br />\nBelow are general HTTP codes applicable across most endpoints:<br />\n- <b>200, 201, 204</b> – Successful operations (retrieval, creation, update, deletion).\n- <b>400</b> – Bad request. Input payloads did not conform to the expected schema or required parameters were missing.\n- <b>401 / 403</b> – Authentication or authorization failed.\n- <b>404</b> – The route or resource was not found.\n- <b>409</b> – Conflict in resource state (e.g., duplicate product identifier).\n- <b>429</b> - Too many requests. See Rate Limits below.\n- <b>500</b> – An unexpected server error occurred.\n- <b>502 / 503 / 504</b> – Infrastructure issues such as load balancer, service unavailability, or timeouts.\n\n<b>API Rate Limits</b><br />\nRate limits are how many API calls you can make in a given time frame. If your call exceeds the pre-defined rate limit, you will run into a “429” http error-code. After which, you will need to wait until you can make another API call.\n\n<b>PIM API Rate Limit:</b> 5 requests/second\n"
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: bulk_products_catalogs
description: "Perform bulk products operation on a Product Catalog\n \nThese endpoints allow you to add or remove products that are associated with a specific product catalog in bulk.\n"
paths:
/bulk/products/product_catalogs:
post:
tags:
- bulk_products_catalogs
summary: Perform bulk products operation on a Product Catalog
description: ' Perform bulk products operation on a Product Catalog
'
operationId: post_api_v1_bulk_products_catalogs
requestBody:
content:
application/json:
schema:
required:
- operation
- product_catalog_id
- product_ids
type: object
properties:
operation:
type: string
description: The operation to perform
enum:
- add
- remove
example: add
product_catalog_id:
type: integer
description: Product Catalog ID
example: 1
product_ids:
type: array
description: Array of Product IDs to add to or remove from the catalog
items:
type: integer
example:
- 1
- 2
- 3
- 4
- 5
example:
operation: add
product_catalog_id: 1
product_ids:
- 1
- 2
- 3
- 4
- 5
required: true
responses:
'200':
description: Bulk products operation on Product Catalog successful
content:
'*/*':
schema:
required:
- products
type: object
properties:
products:
type: array
description: Array of Products
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
nullable: true
description: First dimension ID
dimension2_id:
type: integer
nullable: true
description: Second dimension ID
dimension3_id:
type: integer
nullable: true
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 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
nullable: true
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
nullable: true
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
nullable: true
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
nullable: true
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
product_custom_attributes:
type: array
description: Array of custom attributes for the variant
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
nullable: true
description: Attribute group ID
additionalProperties: false
additionalProperties: false
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 Catalog ID not found
content: {}
'422':
description: There was an error with your bulk products operation on the catalog
content: {}
'500':
description: Something went wrong
content: {}
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: AccessToken
x-original-swagger-version: '2.0'