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

The fulfillments API from Canal — 2 operation(s) for fulfillments.

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version 1.0.1.

Requests are made against a single base URL, https://api.shopcanal.com/platform.

5 operations 2 paths 11 schemas 2 GET1 PATCH1 POST1 PUT

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 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_list 2 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_create body → 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_retrieve 1 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_update 1 param body → 200400401404
PATCH
/fulfillments/{id}/
fulfillments_partial_update 1 param body → 200

Schemas 11

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

Shop
object
12 properties 6 required
Status406Enum
string
pending - pending open - open success - success cancelled - cancelled error - error failure - failure
Error
object
2 properties
LineItemRead
object
8 properties 5 required
Fulfillment
object
11 properties 5 required
LineItem
object
2 properties 2 required
UpdateFulfillment
object
7 properties 4 required
PaginatedFulfillmentList
object
3 properties 1 required
CreateFulfillment
object
9 properties 6 required
PatchedFulfillment
object
11 properties
ShipmentStatusEnum
string
labelprinted - labelprinted labelpurchased - labelpurchased attempteddelivery - attempteddelivery readyforpickup - readyforpickup confirmed - confirmed intrans…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canal-fulfillments-api-openapi.yml Raw ↑

Other APIs Canal publishes across the network.

Canal csv API
AE Profile APIs.io
Canal markets API
AE Profile APIs.io
Canal max-shipping-rates API
AE Profile APIs.io
Canal orders 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
#Fulfillments
← Back to C APIs
API Details
ID
canal:canal-fulfillments-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-fulfillments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/canal-fulfillments-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 fulfillments 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.