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-and-shipping API

The tax-and-shipping API from Canal — 2 operation(s) for tax-and-shipping.

Canal tax-and-shipping 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-and-shipping. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 2 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.

2 operations 2 paths 11 schemas 2 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-and-shipping 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 2

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

tax-and-shipping 2
POST
/tax-and-shipping/calculate/
[Storefront Only] Calculate estimated tax lines and available shipping options and costs, given a set of line items, shipping address, and optionally a billing address. This endpoint is typically use…
tax_and_shipping_calculate_create body → 200400401404500
POST
/tax-and-shipping/v1/calculate/
[Storefront Only] Calculate estimated tax lines and available shipping options and costs, given a set of line items, shipping address, and optionally a billing address. This endpoint is typically use…
tax_and_shipping_v1_calculate_create body → 200400401404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are TaxAndShippingAddress (10 properties), TaxAndShippingLineItemResponse (6 properties), TaxAndShippingResponse (5 properties), ShippingDetails (4 properties). Each schema is shown below with its type and property counts.

ShippingDetails
object
4 properties 3 required
TaxLineResponse
object
4 properties 3 required
CreateOrderLineItem
object
3 properties 2 required
TaxCalculationQuerySerializerV1
object
4 properties 3 required
TaxAndShippingAddress
object
Address serializer for tax and shipping calculations where address1 and name are optional
10 properties 4 required
ShippingRate
object
4 properties 3 required
TaxCalculationQuery
object
3 properties 2 required
TaxAndShippingResponseSerializerV1
object
3 properties 2 required
TaxAndShippingResponse
object
5 properties 4 required
TaxAndShippingLineItemResponse
object
6 properties 4 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canal-tax-and-shipping-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