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

The returns API from Canal — 4 operation(s) for returns.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 5 operations across 4 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.

5 operations 4 paths 10 schemas 2 GET3 POST

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 returns 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 5

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

returns 5
GET
/returns/
Retrieve a paginated list of return requests associated with the authenticated store, reflecting its role. - If called by a Storefront: Returns ReturnRequest records initiated by this Storefront for…
returns_list 3 params → 200400401404
POST
/returns/
[Storefront Only] Initiate a return process for items purchased in a Rokt Catalog-facilitated order. Request Body (ReturnCreateSerializer): - orderid (UUID, required): The Catalog ID of the original…
returns_create body → 201400401403404
GET
/returns/{id}/
returns_retrieve 1 param → 200
POST
/returns/{id}/close/
[Supplier Only] Mark a return request that your Supplier account received from a Storefront as 'CLOSED'. Identify the return request by its Rokt Catalog ID (UUID) provided in the URL path. Use Case:…
returns_close_create 1 param body → 200400401403404
POST
/returns/{id}/update_tracking/
[Storefront Only] Add or update the tracking information for the shipment returning items back to the Supplier(s). Identify the specific return request using its Rokt Catalog ID (UUID) in the URL pat…
returns_update_tracking_create 3 params body → 200400401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Return (10 properties), ReturnCreate (6 properties), ReturnLineItem (6 properties), ReverseDelivery (5 properties). Each schema is shown below with its type and property counts.

ReturnCreate
object
6 properties 4 required
ReturnLineItem
object
6 properties 3 required
CreateReturnLineItem
object
4 properties 3 required
ReverseDeliveryCreate
object
5 properties 1 required
Error
object
2 properties
ReturnReasonEnum
string
color - color defective - defective notasdescribed - notasdescribed other - other sizetoolarge - sizetoolarge sizetoosmall - sizetoosmall style - style unknown…
Return
object
10 properties 7 required
Status602Enum
string
canceled - canceled closed - closed declined - declined open - open requested - requested
ReverseDelivery
object
5 properties 1 required
PaginatedReturnList
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canal-returns-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 products API
AE Profile APIs.io
Canal refunds 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
#Returns
← Back to C APIs
API Details
ID
canal:canal-returns-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-returns-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/canal-returns-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 returns 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.