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 shops API

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

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

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

This API exposes 3 operations across 2 paths, and defines 4 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.

3 operations 2 paths 4 schemas 2 GET1 POST

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 shops 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 3

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

shops 3
GET
/shops/
[Storefront Only] Retrieve a paginated list of Supplier shops with whom your Storefront has an active and approved partnership connection. This endpoint provides essential details for each connected…
shops_list 2 params → 200400401404
POST
/shops/
[Storefront Only] Initiate partnership connection requests with one or more existing Rokt Catalog Suppliers by specifying their primary contact email addresses. In the request body, provide a list of…
shops_create body → 201400401404
GET
/shops/{id}/
[Storefront Only] Retrieve the full profile details for a specific Supplier shop, identified by its unique Rokt Catalog ID (UUID) provided in the URL path. Access is restricted: this endpoint will on…
shops_retrieve 1 param → 200400401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Shop (12 properties), PaginatedShopList (3 properties), Error (2 properties), BulkCreateSupplierPartnership (1 property). Each schema is shown below with its type and property counts.

Shop
object
12 properties 6 required
PaginatedShopList
object
3 properties 1 required
BulkCreateSupplierPartnership
object
1 property 1 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canal-shops-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