Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canal product_sets API

The product_sets API from Canal — 2 operation(s) for product_sets.

Canal product_sets API is one of 17 APIs that Canal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include product_sets. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.1.

Requests are made against a single base URL, https://api.shopcanal.com/platform.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.1
Base URL
https://api.shopcanal.com/platform
Authentication
HTTP Basic, API Key, API Key
Resource Areas
1

Authentication & Security 3

Canal product_sets API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CANAL-APP-ID (platformAppId). An API key is passed in the header as X-CANAL-APP-TOKEN (platformAppToken).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

product_sets 2
GET
/product_sets/
Returns a paginated list of product sets (IDs and lightweight metadata) for suppliers connected to the authenticated store. Each result includes: productsetid, supplierid, name, description, type (e.…
product_sets_list 4 params → 200400401403500
GET
/product_sets/items/
Returns a paginated list of variants that belong to product sets. Each result includes: variantid, productid, productsetid, createdat, updatedat. Optional filters: productsetid (UUID), updatedsince (…
product_sets_items_list 4 params → 200400401403500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ProductSetItem (8 properties), ProductSet (7 properties), PaginatedProductSetItemList (3 properties), PaginatedProductSetList (3 properties). Each schema is shown below with its type and property counts.

PaginatedProductSetList
object
3 properties 1 required
PaginatedProductSetItemList
object
3 properties 1 required
ProductSetItem
object
8 properties 8 required
ProductSet
object
7 properties 5 required
TypeEnum
string
MANUAL - Manual RULEBASED - Rule-based
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canal-product-sets-api-openapi.yml Raw ↑

Other APIs Canal publishes across the network.

Canal csv API
Canal fulfillments API
Canal markets API
Canal max-shipping-rates API
Canal orders API
Canal products API
Canal refunds API
Canal returns API
Canal selection API
Canal shipping API
Canal shipping-rates API
Canal shops API