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

Elastic Path Tax Items API

Taxes differ by country and can differ within the country by region, state, or province. Each jurisdiction has a unique tax code and rate. If your store serves many jurisdictions, integrate a third-party tax generator to manage taxes. If your store serves a few jurisdictions, you can use the API to define the tax codes and rates in Composable Commerce.Taxes are calculated after all promotional discounts have been applied. When calculating taxes on a cart or order, you can choose from the following methods for calculating taxes: - Simple calculation method: Taxes are calculated at the unit level and are rounded to the nearestpenny for the unit. - Line calculation method: Default. Taxes are calculated at the line level and are rounded to thenearest penny for the line. For more information about calculation methods, see [Calculate cart and order totals](/guides/How-To/Carts/calculate-totals).Tax values can be either `rate` or `amount`. - `rate` - Represents the tax as a percentage in decimal form. - `amount` - Represents a tax amount.:::noteTax items can be added and removed using [client_credentials access tokens](/docs/api/authentication/create-an-access-token). Only administrators with `client-credentials` access tokens are able to manage tax items.:::

Elastic Path Tax Items API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Tax Items. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

8 operations 5 paths 10 schemas 3 DELETE3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Tax Items API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 8

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

Tax Items 8

Taxes differ by country and can differ within the country by region, state, or province. Each jurisdiction has a unique tax code and rate. If your store serves many jurisdictions,…

POST
/v2/carts/{cartID}/items/{cartitemID}/taxes
Add Tax Item to Cart
addTaxItemToCart 2 params body → 200201422
POST
/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes
Add Tax Item to Bundle Component
addTaxItemToCartItemComponent 3 params body → 201400404422500
PUT
/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes/{taxitemID}
Update Tax Item on Bundle Component
updateTaxItemFromCartItemComponent 4 params body → 200
DELETE
/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes/{taxitemID}
Delete Tax Item from Bundle Component
deleteTaxItemFromCartItemComponent 4 params → 204404500
POST
/v2/carts/{cartID}/taxes
Bulk Add Tax Items to Cart
bulkAddTaxItemsToCart 1 param body → 200201422
DELETE
/v2/carts/{cartID}/taxes
Bulk Delete Tax Items from Cart
bulkDeleteTaxItemsFromCart 1 param → 204404
PUT
/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}
Update a Tax Item
updateATaxItem 3 params body → 200
DELETE
/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}
Delete a Tax Item
deleteATaxItem 3 params → 204

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CartsItemsTaxesCommon (7 properties), Response.ErrorItem (5 properties), CartsBulkTaxes (3 properties), Response.ErrorResponse (1 property). Each schema is shown below with its type and property counts.

CartsItemsTaxesWithRate
Response.ErrorResponse
object
1 property 1 required
CartsItemsTaxesWithAmount
Response.ErrorItem
object
5 properties 2 required
CartItemRelationship
object
1 property
AddAllOrNothingOptionsObject
object
1 property
CartsItemsTaxesCommon
object
7 properties 1 required
CartItemTaxesEntityResponse
object
1 property 1 required
CartsBulkTaxes
object
3 properties
CartsItemsTaxesObject
A tax item that can be applied to cart items or bundle components. You must specify either a rate (percentage) or an amount (fixed value), but not both.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-tax-items-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API