Create a Tax Rate - Spree Commerce documentation

Community

Github

API basics

Storefront API

Authentication
Account
Account / Address
Account / Credit Cards
Account / Orders
Order Status
Cart
Cart / Line Items
Cart / Other
Cart / Coupons
Checkout
Checkout / State
Checkout / Shipments
Checkout / Payments
Checkout / Store Credit
Stripe
Products
Vendors
Stores
Taxons
Countries
CMS Pages
Menus
Wishlists
Wishlists / Wished Items
Digital Downloads

Platform API

Authentication
Addresses
Adjustments
Classifications
CMS Pages
CMS Sections
Countries
Data Feeds
Digital Links
Digital Assets
Line Items
Menu Items
Menus
Option Types
Option Values
Orders
Payment Methods
Payments
Products
Promotion Actions
Promotion Categories
Promotion Rules
Promotions
Roles
Shipments
Shipping Categories
Shipping Methods
States
Stock Items
Stock Locations
Store Credit Categories
Store Credit Types
Store Credits
Tax Categories
Tax Rates
- GET
  Return a list of Tax Rates
- POST
  Create a Tax Rate
- GET
  Return a Tax Rate
- DEL
  Delete a Tax Rate
- PATCH
  Update a Tax Rate
Taxonomies
Taxons
Users
Variants
Vendors
Webhook Events
Webhook Subscribers
Wished Items
Wishlists
Zones

POST

api

platform

tax_rates

curl --request POST \
  --url http://{defaultHost}/api/v2/platform/tax_rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tax_rate": {
    "amount": 0.05,
    "zone_id": "2",
    "tax_category_id": "1",
    "included_in_price": true,
    "name": "California",
    "show_rate_in_label": false,
    "calculator_attributes": {
      "type": "Spree::Calculator::FlatRate",
      "preferences": {
        "amount": 0,
        "currency": "USD"
      }
    }
  }
}'

{
  "data": {
    "id": "16",
    "type": "tax_rate",
    "attributes": {
      "amount": "0.1",
      "included_in_price": false,
      "created_at": "2022-11-08T19:35:44.601Z",
      "updated_at": "2022-11-08T19:35:44.601Z",
      "name": "TaxRate - 772641",
      "show_rate_in_label": true,
      "deleted_at": null,
      "public_metadata": {},
      "private_metadata": {}
    },
    "relationships": {
      "zone": {
        "data": null
      },
      "tax_category": {
        "data": {
          "id": "167",
          "type": "tax_category"
        }
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include

string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

Body

application/json

tax_rate

object

required

tax_rate.amount

number

required

Example:

0.05

tax_rate.tax_category_id

string

required

Example:

"1"

tax_rate.calculator_attributes

object

required

tax_rate.zone_id

string

Example:

"2"

tax_rate.included_in_price

boolean

Example:

true

tax_rate.name

string

Example:

"California"

tax_rate.show_rate_in_label

boolean

Example:

false

Response

201

application/vnd.api+json

Record created

data

object

required

Was this page helpful?

Suggest edits Raise issue

Return a list of Tax Rates Return a Tax Rate

curl --request POST \
  --url http://{defaultHost}/api/v2/platform/tax_rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tax_rate": {
    "amount": 0.05,
    "zone_id": "2",
    "tax_category_id": "1",
    "included_in_price": true,
    "name": "California",
    "show_rate_in_label": false,
    "calculator_attributes": {
      "type": "Spree::Calculator::FlatRate",
      "preferences": {
        "amount": 0,
        "currency": "USD"
      }
    }
  }
}'

{
  "data": {
    "id": "16",
    "type": "tax_rate",
    "attributes": {
      "amount": "0.1",
      "included_in_price": false,
      "created_at": "2022-11-08T19:35:44.601Z",
      "updated_at": "2022-11-08T19:35:44.601Z",
      "name": "TaxRate - 772641",
      "show_rate_in_label": true,
      "deleted_at": null,
      "public_metadata": {},
      "private_metadata": {}
    },
    "relationships": {
      "zone": {
        "data": null
      },
      "tax_category": {
        "data": {
          "id": "167",
          "type": "tax_category"
        }
      }
    }
  }
}