Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canal tax API

The tax API from Canal — 1 operation(s) for tax.

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

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

This API exposes 1 operation across 1 path, and defines 6 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.

1 operations 1 paths 6 schemas 1 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 tax 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

tax 1
POST
/tax/calculate/
[Storefront Only] Calculate estimated tax lines for a set of line items and a shipping address.
tax_calculate_create body → 200400401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TaxAndShippingAddress (10 properties), TaxLinePerSupplierResponse (4 properties), TaxLineResponse (4 properties), TaxCalculationQuery (3 properties). Each schema is shown below with its type and property counts.

CreateOrderLineItem
object
3 properties 2 required
TaxLineResponse
object
4 properties 3 required
TaxAndShippingAddress
object
Address serializer for tax and shipping calculations where address1 and name are optional
10 properties 4 required
TaxCalculationQuery
object
3 properties 2 required
TaxLinePerSupplierResponse
object
4 properties 3 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canal-tax-api-openapi.yml Raw ↑

Other APIs Canal publishes across the network.

Canal csv API
Canal fulfillments API
Canal markets API
Canal max-shipping-rates API
Canal orders API
Canal product_sets API
Canal products API
Canal refunds API
Canal returns API
Canal selection API
Canal shipping API
Canal shipping-rates API