API Version 2
  • API V2 Overview
  • Category
    • Company
      • Customers
        • Orders
          • Pages
            • Page Templates
              • Products
                • Purchase Orders
                  • SKUs
                    • Support Tickets
                      • Tax Regions
                        • Vendors
                          • Warehouses
                            API Documentation

                            taxregions/info

                            Type Info
                            List Tax Regions
                            URL http://{domain}/api/v2/taxregions/info.json
                            Accepts Filters No
                            Output Attributes
                            Yes


                            Tax Regions Info Data

                            Gets Tax Regions INFO. Using this API one can retrieve detailed information on the Tax Regions which have been input into Lead Commerce based on Lead Commerce Tax Region IDs. The specific data points include ID, name, status, tax_rate, region, subregion, tax_subregion data blocks, etc. The ID is the primary key identifier for Tax Regions in Lead Commerce, the name is the Tax Region name, the status is the status of the Tax Region and the tax_subregion data blocks are the individual tax rates for each specified subregion.
                            Filters
                            Filter the Tax Regions into a list. Tax Region Attributes are available as a filter. Attributes are user defined customizable fields which use graphical control elements such as Text Box, Checkbox and Dropdown Menu.
                            Parameter Type Rules Example
                            id int / array one id or multiple Lead Commerce tax region ids
                            1 or array(3,8,9,45)

                            Sale Based On
                            1 Origin (Warehouse)
                            2 Destination (Shipment)

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "1": [
                                  {
                                    "id": "1",
                                    "name": "California",
                                    "tax_rate": "0.07500",
                                    "sale_based": "2",
                                    "shipment_tax": "1",
                                    "status": "1",
                                    "region": "United States",
                                    "subregion": "California",
                                    "tax_subregion": [
                                      {
                                        "id": "1",
                                        "tax_rate": "0.09000",
                                        "postal_code": "92110"
                                      },
                                      {
                                        "id": "2",
                                        "tax_rate": "0.08000",
                                        "postal_code": "90015"
                                      }
                                    ]
                                  }
                                ],
                                "2": [
                                  {
                                    "id": "2",
                                    "name": "Texas",
                                    "tax_rate": "0.06250",
                                    "sale_based": "2",
                                    "shipment_tax": "0",
                                    "status": "1",
                                    "region": "United States",
                                    "subregion": "Texas",
                                    "tax_subregion": [
                                      {
                                        "id": "3",
                                        "tax_rate": "0.08250",
                                        "postal_code": "75201"
                                      },
                                      {
                                        "id": "4",
                                        "tax_rate": "0.00080",
                                        "postal_code": "79908"
                                      }
                                    ]
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.