Docs
Management API
Tax customers

Tax Customers

Configure customer tax data for use in tax calculations.

Get Tax Customers

GET /tax/customers

Request

Retrieves a list of customer tax data.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • customer_id:in in query - array
    ID of customer. To target multiple customers, provide a comma-separated list of IDs such as 12,34,56.
    Type: array[integer]

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/customers' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

example

{
"data": [
{
"customer_id": 157,
"tax_properties": {
"A-123456789": "26",
"B-6731789": "200"
}
}
],
"meta": {}
}

Update Tax Customers

PUT /tax/customers

Request

Update the tax data associated with one or more customers. This operation will be additive to any values already associated with the customer, overwriting any existing values.

Authentication

  • X-Auth-Token in header

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

  • customer_id    integer
    required

    A reference to the customer.
    Example: 157

  • tax_properties    object
    required

    A simple key-value pairing. The tax property must be defined to associate a value. These values will be sent to the active tax provider during Tax Provider API operations whenever the associated customer is included in the operation.

    Example: {"A-123456789":"26","B-6731789":"200"}

Example

[
{
"customer_id": 157,
"tax_properties": {
"A-123456789": "26",
"B-6731789": "200"
}
}
]

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

example

{
"data": [
{
"customer_id": 157,
"tax_properties": {
"A-123456789": "26",
"B-6731789": "200"
}
}
],
"meta": {}
}

Delete Tax Customers

DELETE /tax/customers

Request

Delete tax data that is associated with one or more customers.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • customer_id:in in query - array
    ID of customer. To target multiple customers, provide a comma-separated list of IDs such as 12,34,56.
    Type: array[integer]

example

curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/customers' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

No Content

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Get a Tax ClassGet Tax Customers