Canal products API is one of 17 APIs that Canal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include products. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
9 operations
across 5 paths,
and defines 17 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.
9 operations5 paths17 schemas1 DELETE3 GET1 PATCH3 POST1 PUT
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 products 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 9
Across 5 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
products 9
GET
/products/
[Storefront Only] Retrieve a paginated list of products accessible to your Storefront through your established Rokt Catalog connections. This endpoint returns products from Suppliers with whom you ha…
products_list4 params→ 200400401404
POST
/products/
[Supplier Only] Create a new product listing within your Rokt Catalog Supplier account. This makes the product manageable through Catalog and potentially available to your connected Storefront partne…
products_createbody→ 201400401404
GET
/products/{id}/
[Storefront Only] Retrieve comprehensive details for a single product, identified by its Rokt Catalog ID (UUID) in the URL path. Access is restricted: this endpoint only returns data for products sou…
products_retrieve1 param→ 200400401404
PUT
/products/{id}/
[Supplier Only] Update attributes of an existing product listing, identified by its Rokt Catalog ID (UUID) in the URL path. This endpoint is used for modifying product-level details. Provide the fiel…
products_update1 parambody→ 200400401404
PATCH
/products/{id}/
products_partial_update1 parambody→ 200
DELETE
/products/{id}/
[Supplier Only] Permanently remove a product listing, identified by its Rokt Catalog ID (UUID) in the URL path, from the Catalog platform. Warning: This action is irreversible. Ensure you intend to d…
products_destroy1 param→ 204400401404
POST
/products/{id}/reorder_variants/
[Supplier Only] Update the display sequence of variants for a specific product. The product is identified by its Rokt Catalog ID (UUID) in the URL path. The request body must contain a field named va…
Resynchronize a retailer (Shopkeep) product with its origin supplier product. If fieldstoresync is provided, only those fields will be updated; otherwise all fields are resynced. On success, returns…
[Storefront Only] Retrieve a paginated list of active products that are eligible for upselling. This endpoint returns products from Suppliers with whom you have an active and approved partnership. Pr…
The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Variant (26 properties), ExternalProduct (20 properties), Product (18 properties), PatchedProduct (18 properties). Each schema is shown below with its type and property counts.
