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

The orders API from Canal — 6 operation(s) for orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 7 operations across 6 paths, and defines 32 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.

7 operations 6 paths 32 schemas 2 GET5 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 orders 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 7

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

orders 7
GET
/orders/
[Storefront Only] Retrieve a paginated list of orders recorded in Rokt Catalog that originated from your Storefront and contain items sourced from Catalog Suppliers. This provides your Storefront's v…
orders_list 2 params → 200400401404
POST
/orders/
[Storefront Only] Record a new customer order placed on your external platform (e.g., your Shopify store) that contains items sourced from Rokt Catalog Suppliers. The request body (OrderCreateSeriali…
orders_create body → 201202400401404422500503
GET
/orders/{id}/
[Storefront Only] Retrieve the full details for a specific Rokt Catalog order, identified by its Catalog ID (UUID) in the URL path. This endpoint provides the Storefront's perspective on the order. A…
orders_retrieve 1 param → 200400401404
POST
/orders/{id}/cancel/
[Storefront Only] Cancel a Rokt Catalog order associated with your Storefront. Identify the order to be cancelled by its Catalog ID (UUID) provided in the URL path. Process: 1. Update Storefront Orde…
orders_cancel_create 1 param → 200400401403404
POST
/orders/create_or_get/
[Storefront Only] Safely create or retrieve a Catalog order using your Storefront's unique order identifier (ordername) to ensure idempotency. Behavior: 1. Check Existing: The system first queries fo…
orders_create_or_get_create body → 200201400401404422500503
POST
/orders/v1/create-and-charge/
[Storefront Only] Create a new order with immediate payment processing. This endpoint combines order creation and payment processing in a single request. The request body follows the same structure a…
orders_v1_create_and_charge_create body → 200201400401404422500503
POST
/orders/v1/initialize-order/
[Storefront Only] Create a new order and receive a Stripe PaymentIntent client secret for frontend payment confirmation. This endpoint allows Storefronts to initiate order creation and receive a Stri…
orders_v1_initialize_order_create body → 200201400401404422500503

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Order (20 properties), Shop (12 properties), Fulfillment (11 properties), TaxAndShippingAddress (10 properties). Each schema is shown below with its type and property counts.

OrderCreateAndChargeV1Response
object
6 properties 2 required
PaginatedOrderList
object
3 properties 1 required
OrderCreateCustomer
object
3 properties 2 required
TokenizedCardResponse
object
1 property 1 required
PaymentDetailsWithTokenizedCardResponse
object
2 properties 1 required
ShippingRate
object
4 properties 3 required
ReverseDelivery
object
5 properties 1 required
Shop
object
12 properties 6 required
Customer
object
5 properties 1 required
OrderShippingDetails
object
4 properties 2 required
ReturnLineItem
object
6 properties 3 required
OrderCreateAndCharge
object
9 properties 4 required
RefundLineItem
object
4 properties 3 required
OrderInitializeAndChargeResponse
object
6 properties 3 required
Error
object
2 properties
LineItemRead
object
8 properties 5 required
Return
object
10 properties 7 required
Status602Enum
string
canceled - canceled closed - closed declined - declined open - open requested - requested
Refund
object
10 properties 6 required
PartialAddressPaymentDetails
object
1 property
PostPurchaseOrderCreate
object
9 properties 3 required
Order
object
20 properties 16 required
ReturnReasonEnum
string
color - color defective - defective notasdescribed - notasdescribed other - other sizetoolarge - sizetoolarge sizetoosmall - sizetoosmall style - style unknown…
TaxAndShippingAddress
object
Address serializer for tax and shipping calculations where address1 and name are optional
10 properties 4 required
ConfirmationDetails
object
7 properties 3 required
OrderInitializeAndChargePaymentDetailsResponse
object
9 properties 8 required
CreateOrderLineItem
object
3 properties 2 required
PaymentDetailsResponse
object
3 properties 1 required
Fulfillment
object
11 properties 5 required
OrderNoteAttribute
object
2 properties 2 required
OrderCreate
object
7 properties 2 required
Address
object
10 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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