Open API v2 / eCommerce / eCommerce Taxes

eCommerce Taxes

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/taxes#

Retrieves a list of taxes by using a "where" filtering

Parameters

Wherestring · query

JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.

Order_Bystring · query

Sort field. Prefix with - for descending; comma-separate for tie-breakers.

Semantic_Querystring · query

Natural-language search, ranked by relevance.

Min_Scorenumber · query

Lowest relevance score to include when using Semantic_Query.

Offsetinteger · query

Number of items to skip before returning results. Defaults to 0.

Limitinteger · query

Maximum number of items to return. Defaults to 100.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

TaxCodestring

A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.).

Countrystring · nullable

The shipping country this tax rate will display for when selected from the shopping cart stage.

Ratenumber

A percentage value (between 0 and 100) used for the tax calculations.

curl "https://your-site.webinone.com/api/v2/admin/taxes" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/taxes", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/taxes",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/taxes', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/taxes");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "TaxCode": "string",
      "Country": "string",
      "Rate": 0
    }
  ],
  "TotalItemsCount": 0
}

POST/api/v2/admin/taxes#

Creates a new tax

Body parameters

TaxCodestringrequired

A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.).

Countrystring · nullable

The shipping country this tax rate will display for when selected from the shopping cart stage.

Ratenumber

A percentage value (between 0 and 100) used for the tax calculations.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

TaxCodestring

A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.).

Countrystring · nullable

The shipping country this tax rate will display for when selected from the shopping cart stage.

Ratenumber

A percentage value (between 0 and 100) used for the tax calculations.

curl -X POST "https://your-site.webinone.com/api/v2/admin/taxes" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"TaxCode":"string","Country":"string","Rate":0}'

await fetch("https://your-site.webinone.com/api/v2/admin/taxes", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "TaxCode": "string",
    "Country": "string",
    "Rate": 0
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/taxes",
    headers={"Authorization": "Bearer <token>"},
    json={
        "TaxCode": "string",
        "Country": "string",
        "Rate": 0
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/taxes', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'TaxCode' => 'string',
        'Country' => 'string',
        'Rate' => 0
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/taxes");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"TaxCode\":\"string\",\"Country\":\"string\",\"Rate\":0}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "TaxCode": "string",
  "Country": "string",
  "Rate": 0
}

GET/api/v2/admin/taxes/{id}#

Retrieves a single tax

Parameters

idinteger · pathrequired

Tax id.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

TaxCodestring

A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.).

Countrystring · nullable

The shipping country this tax rate will display for when selected from the shopping cart stage.

Ratenumber

A percentage value (between 0 and 100) used for the tax calculations.

curl "https://your-site.webinone.com/api/v2/admin/taxes/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/taxes/1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/taxes/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/taxes/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/taxes/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "TaxCode": "string",
  "Country": "string",
  "Rate": 0
}

PUT/api/v2/admin/taxes/{id}#

Updates an existing tax

Parameters

idinteger · pathrequired

Existent tax id.

Body parameters

TaxCodestringrequired

A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.).

Countrystring · nullable

The shipping country this tax rate will display for when selected from the shopping cart stage.

Ratenumber

A percentage value (between 0 and 100) used for the tax calculations.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

TaxCodestring

A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.).

Countrystring · nullable

The shipping country this tax rate will display for when selected from the shopping cart stage.

Ratenumber

A percentage value (between 0 and 100) used for the tax calculations.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/taxes/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"TaxCode":"string","Country":"string","Rate":0}'

await fetch("https://your-site.webinone.com/api/v2/admin/taxes/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "TaxCode": "string",
    "Country": "string",
    "Rate": 0
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/taxes/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "TaxCode": "string",
        "Country": "string",
        "Rate": 0
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/taxes/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'TaxCode' => 'string',
        'Country' => 'string',
        'Rate' => 0
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/taxes/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"TaxCode\":\"string\",\"Country\":\"string\",\"Rate\":0}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "TaxCode": "string",
  "Country": "string",
  "Rate": 0
}

DELETE/api/v2/admin/taxes/{id}#

Deletes an existing tax

Parameters

idinteger · pathrequired

Existent tax id.

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/taxes/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/taxes/1", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/taxes/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/taxes/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/taxes/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);