How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canal Variants API

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

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.2.0, at version 1.0.1.

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

6 operations 2 paths 10 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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/
Variants list
variants_list 2 params → 200400401404
POST
/variants/
Variants create
variants_create body → 201400401404
GET
/variants/{id}/
Variants retrieve
variants_retrieve 1 param → 200400401404
PUT
/variants/{id}/
Variants update
variants_update 1 param body → 200400401404
PATCH
/variants/{id}/
Variants partial update
variants_partial_update 1 param body → 200
DELETE
/variants/{id}/
Variants destroy
variants_destroy 1 param → 200400401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Variant (26 properties), PatchedVariant (26 properties), Product (18 properties), CreateVariant (14 properties). Each schema is shown below with its type and property counts.

Shop
object
12 properties 6 required
PatchedVariant
object
26 properties
PaginatedVariantList
object
3 properties 1 required
InventoryPolicyEnum
string
continue - continue deny - deny
Error
object
2 properties
Status2eaEnum
string
active - active draft - draft archived - archived unlisted - unlisted
Image
object
9 properties 2 required
Product
object
18 properties 5 required
CreateVariant
object
14 properties 5 required
Variant
object
26 properties 14 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canal-variants-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 Product Sets API
Canal Products API
Canal Refunds API
Canal Returns API
Canal Selection API
Canal Shipping API
Canal Shipping Rates API
Where this information came from

This is an independent, third-party profile of Canal Variants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.