Canal shops API
The shops API from Canal — 2 operation(s) for shops.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/canal-shops-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Rokt Catalog csv Shops API
version: 1.0.1
description: Integrate with Rokt Catalog
servers:
- url: https://api.shopcanal.com/platform
description: Rokt Catalog Storefront Public API
tags:
- name: shops
paths:
/shops/:
get:
operationId: shops_list
description: '
**[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 Supplier, such as their name, Rokt Catalog ID, contact information, and domain.
Use this to get an overview of your current Supplier network within Catalog.
You can filter this list to find a specific Supplier by providing their `canal_contact_email` using the `email` query parameter (ensure proper URL encoding if the email contains special characters like ''+'').
Results are returned using cursor-based pagination, ordered by `updated_at` descending by default. Standard ordering fields like `created_at` and `name` are also available.
'
parameters:
- name: cursor
required: false
in: query
description: The pagination cursor value.
schema:
type: string
- in: query
name: email
schema:
type: string
format: email
description: Filter by the Supplier's primary contact email address.
tags:
- shops
security:
- platformAppId: []
platformAppToken: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedShopList'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
post:
operationId: shops_create
description: '
**[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 strings under the key `canal_contact_emails`.
For each email address that corresponds to an active Catalog Supplier shop, Catalog will record your request to connect, initially in a **pending** state.
The Supplier must then **approve** this request (usually through the Catalog web application) for the connection to become active.
Once approved, the Supplier will appear in your ''My Suppliers'' list within the Catalog app, and you will gain access to view and potentially sell their products based on the agreed terms.
This endpoint returns a `201 Created` status along with the details (using `ShopSerializer`) of the Supplier shops for which pending connection requests were successfully created. It does not wait for Supplier approval. If an email does not match an active Supplier, no request is created for that email.
'
tags:
- shops
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCreateSupplierPartnership'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BulkCreateSupplierPartnership'
multipart/form-data:
schema:
$ref: '#/components/schemas/BulkCreateSupplierPartnership'
required: true
security:
- platformAppId: []
platformAppToken: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Shop'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
/shops/{id}/:
get:
operationId: shops_retrieve
description: '
**[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 only return data if an **active and approved** partnership connection exists between your Storefront and the specified Supplier.
The response includes comprehensive details like shop name, ID, contact info, address, configured settings (if applicable), etc.
If the provided `ID` is invalid, does not correspond to a Supplier shop, or if no approved connection exists, a `404 Not Found` error will be returned.
'
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- shops
security:
- platformAppId: []
platformAppToken: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shop'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: ''
components:
schemas:
BulkCreateSupplierPartnership:
type: object
properties:
canal_contact_emails:
type: array
items:
type: string
format: email
required:
- canal_contact_emails
Shop:
type: object
properties:
id:
type: string
format: uuid
readOnly: true
email:
type:
- string
- 'null'
readOnly: true
phone:
type:
- string
- 'null'
maxLength: 128
name:
type: string
maxLength: 129
description:
type:
- string
- 'null'
maxLength: 6144
myshopify_domain:
type: string
maxLength: 128
province:
type:
- string
- 'null'
maxLength: 122
country:
type: string
maxLength: 64
domain:
type:
- string
- 'null'
maxLength: 128
display_domain:
type:
- string
- 'null'
readOnly: true
privacy_policy_url:
type:
- string
- 'null'
format: uri
maxLength: 500
terms_of_service_url:
type:
- string
- 'null'
format: uri
maxLength: 500
required:
- country
- display_domain
- email
- id
- myshopify_domain
- name
PaginatedShopList:
type: object
required:
- results
properties:
next:
type:
- string
- 'null'
format: uri
example: http://api.example.org/accounts/?cursor=cD00ODY%3D"
previous:
type:
- string
- 'null'
format: uri
example: http://api.example.org/accounts/?cursor=cj0xJnA9NDg3
results:
type: array
items:
$ref: '#/components/schemas/Shop'
Error:
type: object
properties:
message:
type: string
detail: {}
securitySchemes:
basicAuth:
type: http
scheme: basic
platformAppId:
type: apiKey
in: header
name: X-CANAL-APP-ID
platformAppToken:
type: apiKey
in: header
name: X-CANAL-APP-TOKEN