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.0.3, at version 1.0.1.
Requests are made against a single base URL, https://api.shopcanal.com/platform.
5 operations4 paths10 schemas2 GET3 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 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_list3 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_createbody→ 201400401403404
GET
/returns/{id}/
returns_retrieve1 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_create1 parambody→ 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…
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Return (10 properties), ReturnLineItem (6 properties), ReturnCreate (6 properties), ReverseDelivery (5 properties). Each schema is shown below with its type and property counts.
ReverseDelivery
object
5 properties1 required
ReturnLineItem
object
6 properties3 required
ReturnReasonEnum
string
color - color defective - defective notasdescribed - notasdescribed other - other sizetoolarge - sizetoolarge sizetoosmall - sizetoosmall style - style unknown…
CreateReturnLineItem
object
4 properties3 required
ReverseDeliveryCreate
object
5 properties1 required
Return
object
10 properties7 required
PaginatedReturnList
object
3 properties1 required
Error
object
2 properties
Status602Enum
string
canceled - canceled closed - closed declined - declined open - open requested - requested
ReturnCreate
object
6 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
