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 orders. 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.0.3, at version 1.0.1.
Requests are made against a single base URL, https://api.shopcanal.com/platform.
7 operations6 paths32 schemas2 GET5 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 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_list2 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_createbody→ 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_retrieve1 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_create1 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…
[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…
[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…
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.
PaymentDetailsResponse
object
3 properties1 required
PartialAddressPaymentDetails
object
1 property
Fulfillment
object
11 properties5 required
CreateOrderLineItem
object
3 properties2 required
RefundLineItem
object
4 properties3 required
TokenizedCardResponse
object
1 property1 required
OrderInitializeAndChargePaymentDetailsResponse
object
9 properties8 required
ReturnReasonEnum
string
color - color defective - defective notasdescribed - notasdescribed other - other sizetoolarge - sizetoolarge sizetoosmall - sizetoosmall style - style unknown…
Shop
object
12 properties6 required
OrderCreate
object
7 properties2 required
Customer
object
5 properties1 required
OrderNoteAttribute
object
2 properties2 required
OrderCreateAndChargeV1Response
object
6 properties2 required
ConfirmationDetails
object
7 properties3 required
TaxAndShippingAddress
object
Address serializer for tax and shipping calculations where address1 and name are optional
10 properties4 required
PostPurchaseOrderCreate
object
9 properties3 required
Return
object
10 properties7 required
ReverseDelivery
object
5 properties1 required
Refund
object
10 properties6 required
OrderInitializeAndChargeResponse
object
6 properties3 required
PaginatedOrderList
object
3 properties1 required
LineItemRead
object
8 properties5 required
ReturnLineItem
object
6 properties3 required
Status602Enum
string
canceled - canceled closed - closed declined - declined open - open requested - requested
PaymentDetailsWithTokenizedCardResponse
object
2 properties1 required
OrderCreateAndCharge
object
9 properties4 required
Address
object
10 properties6 required
OrderCreateCustomer
object
3 properties2 required
Order
object
20 properties16 required
OrderShippingDetails
object
4 properties2 required
ShippingRate
object
4 properties3 required
Error
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
