Docs
Management API
Tax Zones

Tax Zones

Get Tax Zones

GET /tax/zones

Request

Retrieve a selection of tax zones when you provide a list of tax zone IDs. Otherwise, retrieve all tax zones defined on the store.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • 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

    Response metadata.

Example 1

Update Tax Zones

PUT /tax/zones

Request

Update one or more tax zones. Only the tax zone 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
  • id
    integer
    required

    Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone.

  • name
    string

    The human-readable name for this tax zone. The name appears in the store control panel.

    Example: Australia

  • enabled
    boolean

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

    Default: true

  • price_display_settings
    object

    Settings that describe how a store displays prices to shoppers matched with this tax zone.

  • shopper_target_settings
    object

    Settings that describe which shoppers match this tax zone and help determine the most appropriate target for a shopper. You cannot define shopper target settings for the default tax zone because it must accommodate all shoppers who donʼt qualify for any other zone.

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

Example 1

Create Tax Zones

POST /tax/zones

Request

Create one or more tax zones.

Note

You cannot create a default tax zone.

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
  • name
    string
    required

    The human-readable name for this tax zone. The name appears in the store control panel.

    Example: Australia

  • enabled
    boolean

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

    Default: true

  • price_display_settings
    object

    Settings that describe how a store displays prices to shoppers matched with this tax zone.

  • shopper_target_settings
    object

    Settings that describe which shoppers match this tax zone and help determine the most appropriate target for a shopper.

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

Example 1

Delete Tax Zones

DELETE /tax/zones

Request

Delete one or more tax zones. Deleting a tax zone removes all associated tax rates.

You must specify which zone(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 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

No Content

Did you find what you were looking for?