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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Canal

Canal products API

The products API from Canal — 5 operation(s) for products.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

9 operations 5 paths 17 schemas 1 DELETE3 GET1 PATCH3 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 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_list 4 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_create body → 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_retrieve 1 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_update 1 param body → 200400401404
PATCH
/products/{id}/
products_partial_update 1 param body → 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_destroy 1 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…
products_reorder_variants_create 1 param body → 200400401404
POST
/products/{id}/resync/
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…
products_resync_create 1 param body → 200202400401404
GET
/products/upsell_products/
[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…
products_upsell_products_list 3 params → 200400401404

Schemas 17

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.

Shop
object
12 properties 6 required
PaginatedExternalProductList
object
3 properties 1 required
Status2eaEnum
string
active - active draft - draft archived - archived unlisted - unlisted
ResyncShopkeepProduct
object
1 property
PushProductVariant
object
13 properties 4 required
Image
object
9 properties 2 required
Product
object
18 properties 5 required
PatchedProduct
object
18 properties
Error
object
2 properties
InventoryPolicyEnum
string
continue - continue deny - deny
Variant
object
26 properties 14 required
ResyncShopkeepProductResponse
object
3 properties 1 required
ExternalProduct
object
20 properties 9 required
PushProduct
object
13 properties 2 required
ReorderVariant
object
1 property 1 required
PushProductStatusEnum
string
active - active draft - draft archived - archived
FieldsToResyncEnum
string
images - images producttitle - producttitle description - description tags - tags variants - variants vendor - vendor permalink - permalink

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canal-products-api-openapi.yml Raw ↑

Other APIs Canal publishes across the network.

Canal csv API
AE Profile APIs.io
Canal fulfillments API
AE Profile APIs.io
Canal markets API
AE Profile APIs.io
Canal max-shipping-rates API
AE Profile APIs.io
Canal orders API
AE Profile APIs.io
Canal product_sets API
AE Profile APIs.io
Canal refunds API
AE Profile APIs.io
Canal returns API
AE Profile APIs.io
Canal selection API
AE Profile APIs.io
Canal shipping API
AE Profile APIs.io
Canal shipping-rates API
AE Profile APIs.io
Canal shops API
AE Profile APIs.io
#Product
← Back to C APIs
API Details
ID
canal:canal-products-api
Base URL
https://api.shopcanal.com/platform
Docs
https://docs.shopcanal.com/docs/getting-started
Provider
Canal
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=canal-products-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/canal-products-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Canal products 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.