Canal fulfillments API is one of 17 APIs that Canal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include fulfillments. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
5 operations
across 2 paths,
and defines 11 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 operations2 paths11 schemas2 GET1 PATCH1 POST1 PUT
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 fulfillments 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 2 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
fulfillments 5
GET
/fulfillments/
Retrieve a paginated list of fulfillment records associated with the authenticated store, reflecting its role in the order process. - If called by a Storefront: Returns fulfillments created by connec…
fulfillments_list2 params→ 200400401404
POST
/fulfillments/
[Supplier Only] Create a fulfillment record for items in an order received from a connected Storefront. The request body (CreateFulfillmentSerializer) must specify: orderid (UUID of the Supplier's Ro…
fulfillments_createbody→ 201400401404
GET
/fulfillments/{id}/
Retrieve the full details for a specific fulfillment record, identified by its Rokt Catalog ID (UUID) in the URL path. Access is restricted to fulfillments associated with the authenticated store (re…
fulfillments_retrieve1 param→ 200400401404
PUT
/fulfillments/{id}/
[Supplier Only] Update an existing fulfillment record created by your Supplier account. Identify the fulfillment by its Rokt Catalog ID (UUID) in the URL path. The request body (UpdateFulfillmentSeri…
fulfillments_update1 parambody→ 200400401404
PATCH
/fulfillments/{id}/
fulfillments_partial_update1 parambody→ 200
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Shop (12 properties), Fulfillment (11 properties), PatchedFulfillment (11 properties), CreateFulfillment (9 properties). Each schema is shown below with its type and property counts.
PatchedFulfillment
object
11 properties
Fulfillment
object
11 properties5 required
UpdateFulfillment
object
7 properties4 required
Shop
object
12 properties6 required
Status406Enum
string
pending - pending open - open success - success cancelled - cancelled error - error failure - failure
