Canal variants API is one of 17 APIs that Canal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include variants. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
6 operations
across 2 paths,
and defines 10 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.
6 operations2 paths10 schemas1 DELETE2 GET1 PATCH1 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 variants 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 6
Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
variants 6
GET
/variants/
[Supplier Only] Retrieve a paginated list of all product variants associated with all products owned by your Supplier account. This endpoint provides a flat list of variant details, independent of th…
variants_list2 params→ 200400401404
POST
/variants/
[Supplier Only] Add a new variant to an existing product within your Rokt Catalog Supplier account. The request body must conform to the CreateVariantSerializer structure, requiring the productid (UU…
variants_createbody→ 201400401404
GET
/variants/{id}/
[Supplier Only] Retrieve the full details for a specific product variant, identified by its Rokt Catalog ID (UUID) provided in the URL path. This endpoint returns data only for variants that belong t…
variants_retrieve1 param→ 200400401404
PUT
/variants/{id}/
[Supplier Only] Update attributes of a specific product variant, identified by its Rokt Catalog ID (UUID) in the URL path. Provide the fields you wish to change in the request body using the VariantS…
variants_update1 parambody→ 200400401404
PATCH
/variants/{id}/
variants_partial_update1 parambody→ 200
DELETE
/variants/{id}/
[Supplier Only] Permanently remove a specific product variant, identified by its Rokt Catalog ID (UUID) in the URL path, from its parent product. Warning: This action is irreversible. Constraint: You…
variants_destroy1 param→ 200400401404
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PatchedVariant (26 properties), Variant (26 properties), Product (18 properties), CreateVariant (14 properties). Each schema is shown below with its type and property counts.
PaginatedVariantList
object
3 properties1 required
PatchedVariant
object
26 properties
CreateVariant
object
14 properties5 required
InventoryPolicyEnum
string
continue - continue deny - deny
Image
object
9 properties2 required
Variant
object
26 properties14 required
Shop
object
12 properties6 required
Status2eaEnum
string
active - active draft - draft archived - archived unlisted - unlisted
Product
object
18 properties5 required
Error
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
