• 1-800-224-0976 US & Canada toll free

tax.class.info

This method lets API2Cart users get tax information from the store.  

Below you will find all needed parameters as well as request and response examples.

Check integration code samples and interactive documentation (Swagger) to see how it works.

Note:

At the response example in the class “tax_class” there is an attribute “tax_type”. When “tax_type” equals 1 - it returns a percentage value of products; When “tax_type” equals 0 - it returns a numeric value.

 Supported Carts

Choose a shopping cart to see what params are available for this platform.

All shopping carts on the list work with this method, docs are coming soon.

 Params

 Response Structure

 

{
  "return_code": int,
  "return_message": string,
  "result":{
    "id": string,
    "name": string,
    "avail": string,
    "tax": decimal,
    "tax_type": int,
    "tax_rates":[ array
      {
        "id": string,
        "name": string,
        "tax": decimal,
        "tax_type": int,
        "tax_based_on": string,
        "countries":[ array
          {
            "id": string,
            "name": string,
            "code": string,
            "tax": decimal,
            "tax_type": int
            "states":[ array
              {
                "id": string,
                "tax": decimal,
                "tax_type": int,
                "name": string,
                "code": string
              },
              ...
            ],
          },
          ...
        ],
        "cities":[ array ],
        "address":[ array ],
        "zip_codes":[ array 
          {
            "is_range": string,
            "range": [ array
              {
                "from": string,
                "to": string
              },
              ...
            ],
            "name": string,
            "fields":[ array ],
          },
        ],
      },
      ...
    ]      
  }
}

 Response Example

 

{
  "return_code":0,
  "return_message":"",
  "result":{
    "id":"5",
    "name":"VAT",
    "avail":"True",
    "tax":1,
    "tax_type":0,
    "tax_rates":[
      {
        "id":"1",
        "name":"Worldwide Zone",
        "tax":1,
        "tax_type":0,
        "tax_based_on":"shipping",
        "countries":[
          {
            "id":null,
            "name":"United States of America",
            "code":"US",
            "tax":1,
            "tax_type":0,
            "states":[
              {
                "id":null,
                "tax":1,
                "tax_type":0,
                "name":"Alaska",
                "code":"AK"
              },
              {
                "id":null,
                "tax":1,
                "tax_type":0,
                "name":"Alabama",
                "code":"AL"
              },
              {
                "id":null,
                "tax":1,
                "tax_type":0,
                "name":"California",
                "code":"CA"
              }
            ]
          },
          {
            "id":null,
            "name":"Afghanistan",
            "code":"AF",
            "tax":7,
            "tax_type":0,
            "states":[
              {
                "id":null,
                "tax":7,
                "tax_type":0,
                "name":"*",
                "code":"*"
              }
            ]
          }
        ],
        "cities":[
          "*"
        ],
        "address":[
          "*"
        ],
        "zip_codes":[
          {
            "is_range":"true",
            "range":[
              {
                "from": "1111111",
                "to": "2222222"
              },
              {
                "from": "3333333",
                "to": "4444444"
              }
            ],
            "fields":[ ]
          }
        ]
      },
      {
        "id":"2",
        "name":"USA Zone",
        "tax":1,
        "tax_type":0,
        "tax_based_on":"billing",
        "countries":[
          {
            "id":null,
            "name":"United States of America",
            "code":"US",
            "tax":7,
            "tax_type":0,
            "states":[
              {
                "id":null,
                "tax":7,
                "tax_type":0,
                "name":"*",
                "code":"*"
              }
            ]
          }
        ],
        "cities":[
          "Dallas",
          "Los Angeles",
          "New Yo%",
          "Washington"
        ],
        "address":[
          "%Manhattan%",
          "127 avenue"
        ],
        "zip_codes":[
          {
            "is_range":"false",
            "range":[
              {
                "from": "",
                "to": ""
              }
            ],
            "fields":[
              "2204%",
              "23%",
              "38245"
            ]
          }
        ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <return_code>0</return_code>
  <return_message></return_message>
  <result>
    <id>5</id>
    <name>VAT</name>
    <avail>True</avail>
    <tax>1</tax>
    <tax_type>0</tax_type>
    <tax_rates>
      <id>1</id>
      <name>Worldwide Zone</name>
      <tax>1</tax>
      <tax_type>0</tax_type>
      <tax_based_on>shipping</tax_based_on>
      <countries>
        <id></id>
        <name>United States of America</name>
        <code>US</code>
        <tax>1</tax>
        <tax_type>0</tax_type>
        <states>
          <id></id>
          <tax>1</tax>
          <tax_type>0</tax_type>
          <name>Alaska</name>
          <code>AK</code>
        </states>
        <states>
          <id></id>
          <tax>1</tax>
          <tax_type>0</tax_type>
          <name>Alabama</name>
          <code>AL</code>
        </states>
        <states>
          <id></id>
          <tax>1</tax>
          <tax_type>0</tax_type>
          <name>California</name>
          <code>CA</code>
        </states>
      </countries>
      <countries>
        <id></id>
        <name>Afghanistan</name>
        <code>AF</code>
        <tax>7</tax>
        <tax_type>0</tax_type>
        <states>
          <id></id>
          <tax>7</tax>
          <tax_type>0</tax_type>
          <name>*</name>
          <code>*</code>
        </states>
      </countries>
      <cities>*</cities>
      <address>*</address>
      <zip_codes>
        <is_range>true</is_range>
        <range>
          <from>1111111</from>
          <to>2222222</to>
        </range>
        <range>
          <from>3333333</from>
          <to>4444444</to>
        </range>
        <fields></fields>
      </zip_codes>
    </tax_rates>
    <tax_rates>
      <id>2</id>
      <name>USA Zone</name>
      <tax>1</tax>
      <tax_type>0</tax_type>
      <tax_based_on>billing</tax_based_on>
      <countries>
        <id></id>
        <name>United States of America</name>
        <code>US</code>
        <tax>7</tax>
        <tax_type>0</tax_type>
        <states>
          <id></id>
          <tax>7</tax>
          <tax_type>0</tax_type>
          <name>*</name>
          <code>*</code>
        </states>
        <cities>Dallas</cities>
        <cities>Los Angeles</cities>
        <cities>New Yo%</cities>
        <cities>Washington</cities>
        <address>%Manhattan%</address>
        <address>127 avenue</address>
        <zip_codes>
          <is_range>false</is_range>
          <range_from></range_from>
          <range_to></range_to>
          <fields>2204%</fields>
          <fields>23%</fields>
          <fields>38245</fields>
        </zip_codes>
      </countries>
    </tax_rates>
  </result>
</response>

 Request Example

 Code Sample


Connector.php

<?php

/**
 * Class Connector
 */
class Connector
{
  /**
   * URL to API API2Cart
   *
   * @var string A2C_URL
   */
  const A2C_URL = 'https://api.api2cart.com/v1.0/';

  /**
   * @var array $_params
   */
  private $_params = array();

  /**
   * @param string $apiKey
   * @param string $storeKey
   */
  public function __construct($apiKey, $storeKey = null)
  {
    $this->_params['api_key']   = $apiKey;

    if($storeKey !== null) {
      $this->_params['store_key'] = $storeKey;
    }
  }


  /**
   * Send request to API2Cart
   *
   * @param string $method Name method
   * @param array  $params List params for method
   *
   * @return stdClass
   *
   * @throws Exception
   */
  public function request($method, $params = array())
  {

    $params = array_merge($this->_params,$params);

    $ch = curl_init();

    $url = self::A2C_URL . $method . '.json?' . http_build_query($params);

    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
    curl_setopt($ch, CURLOPT_HEADER, false);
    curl_setopt($ch, CURLOPT_TIMEOUT, 300);
    curl_setopt($ch, CURLINFO_HEADER_OUT,true);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_USERAGENT, 
      "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; " .
      "rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1");
    curl_setopt($ch, CURLOPT_HTTPHEADER, array (
      "Accept: */*",
    ));

    try {

      $response = trim(curl_exec($ch));

      if(curl_errno($ch) != CURLE_OK) {
        throw new Exception(curl_error($ch));
      }

      curl_close($ch);

      return $this->validate($response);

    } catch (Exception $e) {

      throw $e;

    }
  }

  /**
   * Validate received response
   *
   * @param string $response Response
   *
   * @return stdClass
   *
   * @throws Exception
   */
  private function validate($response)
  {
    $result = json_decode($response);

    if($result === null) {
      throw new Exception('Response NULL');
    }

    if($result->return_code != 0) {
      throw new Exception($result->return_message, $result->return_code);
    }

    return $result->result;
  }
}
See More
Integration Code Samples
Full code sample on Git Hub

 Try Now (Swagger)