Docs
Management API
Tax Rates

Tax Rates

Get Tax Rates

GET /tax/rates

Request

Retrieve a list of tax rates.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • id:in in query - array

    Filter by tax rate id. Use a comma-separated CSV string of IDs for multiple tax rates. For example, 5 or 12,34,56.

    Type: array[integer]

  • tax_zone_id:in in query - array

    Filter by tax zone id. Use a comma-separated CSV string of IDs for multiple tax zones. For example, 5 or 12,34,56.

    Type: array[integer]

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

Update Tax Rates

PUT /tax/rates

Request

Update one or more tax rates. Only the tax rate id field is required. Fields unspecified by the request will retain their current state.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

array | application/json
  • class_rates
    array[object]

    Tax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.

  • enabled
    boolean

    Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.

    Default: true

  • id
    integer
    required

    Tax Rate ID. Internal identifier to update and delete a specific tax rate.

    Example: 3

  • name
    string

    The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings.

    Example: Sales Tax

  • priority
    integer

    Allows for compounding tax rates, common in certain jurisdictions.

    Default: 1

  • tax_zone_id
    integer

    ID of an associated tax zone. You must associate a tax rate with a tax zone.

    Example: 2

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

Example 1

Create Tax Rates

POST /tax/rates

Request

Create one or more tax rates. Tax rates must be associated with a tax_zone_id.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

array | application/json
  • class_rates
    array[object]
    required

    Tax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.

  • enabled
    boolean

    Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.

    Default: true

  • name
    string
    required

    The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings.

    Example: Sales Tax

  • priority
    integer

    Allows for compounding tax rates, common in certain jurisdictions.

    Default: 1

  • tax_zone_id
    integer
    required

    ID of an associated tax zone. You must associate a tax rate with a tax zone.

    Example: 2

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

Example 1

Delete Tax Rates

DELETE /tax/rates

Request

Delete one or more tax rates.

You must specify which rate(s) to delete using the id:in query parameter.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • id:in in query - array

    Filter by tax rate id. Use a comma-separated CSV string of IDs for multiple tax rates. For example, 5 or 12,34,56.

    Type: array[integer]

example

Response

No Content

Did you find what you were looking for?