Canal refunds API
The refunds API from Canal — 2 operation(s) for refunds.
Canal refunds API is one of 17 APIs that Canal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include refunds. 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 7 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Canal refunds 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.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Refund (10 properties), LineItemRead (8 properties), RefundLineItem (4 properties), RefundCreate (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Canal 12
Other APIs Canal publishes across the network.