Add Tax Item to Cart

POST 
/v2/carts/:cartID/items/:cartitemID/taxes

Use this endpoint to add a tax item to a cart.

note

There is a soft limit of 5 unique tax items per cart item at any one time.

Request

Path Parameters

cartID stringrequired

The unique identifier of the cart.

cartitemID stringrequired

The unique identifier of the cart item.

application/json

Body

data object

code string

A unique tax code in this jurisdiction.

jurisdiction string

The relevant tax jurisdiction.

name string

The name of the tax item.

rate numberrequired

The tax rate represented as a decimal (12.5% -> 0.125).

type stringrequired

The type of object being returned. Use tax_item.

Responses

200

Response Headers

application/json

Schema

Schema

data object

code string

A unique tax code in this jurisdiction.

jurisdiction string

The relevant tax jurisdiction.

name string

The name of the tax item.

rate numberrequired

The tax rate represented as a decimal (12.5% -> 0.125).

type stringrequired

The type of object being returned. Use tax_item.

id uuid

The unique identifier for this tax item.

Example (from schema)

{
  "data": {
    "code": "string",
    "jurisdiction": "string",
    "name": "string",
    "rate": 0,
    "type": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

422

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 422,
    "title": "Unprocessable Entity"
  }
}

Loading...