税务提供商API.

这税务提供商API.允许您向店面的购物者提供企业对消费者的销售税估计，并在控制面板中的商家;它也可用于提交税务和解目的的文件。

这税务提供商API.与BIGCommerce应用程序一起工作，因此您需要建立一个应用程序这整合了这一点税务提供商API.。

多租户税收提供商可以选择发布他们的BIGCommerce应用程序，以便它被任何人发现，或者将应用程序发布为未列出，以便只能通过URL安装它。此外，还支持内部内部或专门的商家的beplayti体育提现税收解决方案也被支持为私人实例，并且只能在指定的商店上工作。

获取应用程序ID

要获取您的应用程序ID，请开始创建应用程序开发人员门户，并填写信息第3步技术。在URL中，您将看到您的唯一应用程序ID。

了解有关查找您的应用程序ID的更多信息。

使用BigCommerce共享提供商详细信息

获得了应用ID后，请通过电子邮件分享您的应用程序ID以及使用BigCommerce的以下信息taxproviderapi@bigcommerce.com.。这允许我们创建税务提供商配置，这需要大约5天。

一旦您的纳税提供商配置准备就绪，我们会通过电子邮件通知您。电子邮件还将包括您的Provider_id.这是必需的建立一个连接与之税务提供商API.。

税务提供商详细信息	必填/可选	价值	描述	例子
应用ID.	必需的	整数	告诉我们在安装应用程序后使用哪种纳税提供商配置。	123456.
税务提供商名称	必需的	细绳	显示在BigCommerce控制面板中（例如商店设置>税务>增加税务服务）。	样本税
税务提供商类型	必需的	生产，沙箱	纳税提供商配置的层次结构，生产主要，沙箱是次要的，看到沙箱税收提供商配置想要查询更多的信息。	生产
合作伙伴支持电子邮件	必需的	电子邮件	通过BigCommerce用于联系税务提供商，在我们需要转发商家支持请求时。	support@sampletax.example.com.
控制面板中显示的链接	可选的	URL，标题，描述	当他们导航到购物者时显示链接商店设置>税务> {税务提供商}。支持一个或多个链接。	support.sampletax.com.那样本税收支持那示例税务支持网站。
覆盖范围
税务提供商可见性	必需的	显示隐藏	告诉我们，如果在相关商店安装税务提供商应用程序之前，应向BigCommerce控制面板中的用户显示税务提供商。	表演
平台可用性	必需的	所有商店，私人实例	告诉我们税务提供者应该在所有商店工作或仅在商店哈希提供的商店上工作。	所有商店
支持的商店	如果平台可用性是必需的私人实例）	商店散列	作为私人实例，税务提供者配置只能在提供的存储哈希上工作。	DWVJNTFQV，EPQ54YYMGQ.
支持/不支持的国家	必需的	ISO 3166-1 Alpha-2	逗号分离ISO 3166-1 Alpha-2支持国家的国家代码。	美国，加利福尼亚州，GB，FR，AU，NZ
URL.
估计URL.	必需的	URL.	URL BigCommerce应用于税务提供商API估算请求。	https://sampletax.example.com/tax/eStimate.
提交网址	可选的	URL.	URL BigCommerce应该用于税务提供商API报价请求。	https://sampletax.example.com/doc/commit.
调整URL.	可选的	URL.	URL BigCommerce应该用于税务提供商API报价请求。	https://sampletax.example.com/doc/adjust.
void网址	可选的	URL.	URL BigCommerce应该用于税务提供商API报价请求。	https://sampletax.example.com/doc/void.
测试
合作伙伴沙箱商店域	必需的	域名	在推出税务提供商之前分享您的合作伙伴沙盒商店以进行测试。学习如何创建合作伙伴沙箱商店。	https://sampletax-test-store.mybigcommerce.com/

沙箱税收提供商配置

Sandbox税务提供商配置嵌套在生产税提供商配置中，因为需要沙箱税收提供商配置的税收提供商还应提供其生产税收提供商配置的详细信息。

此外，在为Sandbox纳税提供商配置提供详细信息时，不必指定以下属性，因为它们是从主要生产纳税提供商配置继承的（仍需要所有其他属性）：

• 商家支持电子邮件
• 商家支持URL
• 税务提供商可见性
• 平台可用性，即所有商店或仅指定的商店哈希
• 支持/不支持的国家

税务提供商可以在其生产税收提供商配置中创建多个沙箱税收提供商，例如税务提供商可以开发，并在其生产税收提供商配置中嵌套测试沙箱税收提供商。

建立应用程序

税务提供商必须建立一个大型商品单击应用程序为了利用税务提供商API提供税收估计并提交税务文件。例如，BigCommerce单击App提供了许多优势，例如，它使纳税提供商能够在BigCommerce应用市场中提升他们的解决方案，请在App安装期间要求API范围的商业授权，并通过IFRame启用税务提供者设置的配置在BigCommerce控制面板中。

回顾我们建筑应用简介指南并使用侧边栏来探索主题：应用类型的类型，在DEV门户中管理应用程序，实现OAuth，以及设计UI。

确保还审查我们的应用开发最佳实践对于一些提示。

安装应用程序

一旦商家点击安装在税务提供者单击App中，应用程序成功处理OAuth流程之前的内容在继续与...建立连接的下一步之前税务提供商API.。这OAuth摘要提供OAuth流程的概述。

处理OAuth流程时，税务提供商必须确保其应用程序正在请求读写权限信息和设置API范围。此外，税务提供者应该存储client_id.和Access_Token.收到了。两者都需要稍后与税务提供商API建立联系。

建立一个连接

税务提供商准备好在下面的所有情况下与税务提供商API建立连接：

• 税务提供商通过电子邮件与BigCommerce共享其税务提供商详细信息，我们已经回复了确认税务提供商配置现在准备好所有提供的商家和/或合作伙伴测试商店（见使用BigCommerce共享提供商详细信息）。
• Bigcommerce已分享Provider_id.通过电子邮件与税务提供商的税务提供者配置（参见使用BigCommerce共享提供商详细信息）。
• 税务提供商建立了一个应用程序草案，它在应用程序安装期间成功处理OAuth流（参见建立应用程序）。
• 在OAuth流期间，应用程序请求商家授权信息和设置API范围的读写权限（参见安装应用程序）。
• 在OAuth流程期间client_id.和Access_Token.收到并由税务提供者储存（见安装应用程序）。

对于上下文，税务提供商API连接端点为税务提供商提供额外的安全层。它们用于设置税务提供商的基本身份验证凭据，这些基本凭据用于从关联商店验证税务提供商对每个API请求进行验证。

如果纳税提供商支持所有符合条件的商店，那么他们可能会选择在其应用程序IFrame中提供帐户注册流，以便从商家捕获这些基本身份验证凭据。了解有关设计APP UI的更多信息这里。

如果纳税提供商是私有实例，则他们可以选择自己提供基本身份验证凭据。

在任何一种情况下，更新连接在成功安装税务提供商的应用程序后，应调用端点。税务提供商需要包括store_hash.那Provider_id.那X-Auth-Client（client_id.） 和X-auth-token（Access_Token.）值。

我们建议致电更新连接成功安装应用程序后立即终端点，否则当商家导航到时，您的纳税提供商将不会显示商店设置>税收页面在BigCommerce控制面板中。

这获得连接可以随时使用请求以在商店的上下文中检索指定纳税提供商的连接状态。

在控制面板中启用税务提供商

一旦纳税提供商的应用程序已成功安装并且通过更新连接请求提供基本身份验证凭据，用户将能够在纳税提供商提供的所有提供的商家和/或合作伙伴测试商店上启用纳税提供商使用BigCommerce共享提供商详细信息。

要启用税务提供商，用户必须导航到商店设置>税收在BigCommerce控制面板中，然后单击使能够在相关税务提供者旁边。

如果支持文档提交，请导航到商店设置>税务> {税务提供商}并确保选中“提交订单数据”复选框。

税收估计

要求税收估计数

在BigCommerce控制面板中已启用税务提供商应用程序，税务提供商准备回应BigCommerce发送的税收估计请求。

将根据BigCommerce Store的设置，在标准的BigCommerce结帐流程中多次请求税估计。

• 在使用时选择送货方式后估算运输和税务功能在购物车页面上
• 在结账时指定送货地址后
• 在结账时指定帐单地址后

以下事件后未预期估算请求。

• 浏览商店的产品目录或产品页面时。
• 在购物者之前的购物车在购物者之前选择了使用的运输方法估算运费和税收功能。
• 在指定送货地址之前在结帐页面上。
• 在结帐页面上，在切换与使用购物者的送货地址相关的任何选项作为计费地址。

使用如下方式使用流量时，还将在控制面板中进行估计呼叫。

• 线项退款流量
• 在用户导航时测试连接功能商店设置>税务> {税务提供商}在BigCommerce控制面板中

响应税收估计请求

在响应BueCommerce发送的税务估计请求时，税务提供商必须包括汇总和销售税额的分类和产品商品价格，运费和处理价格的税率。这是因为当导航到商店设置>税务>税收设置页面在BigCommerce控制面板中，商家有能力指定他们是否希望在购物车，结账，订单和发票中显示税款作为一个总结线项或者按税率分解。

查看估算税API参考。

文件提交

文档提交使纳税提供商能够持续税务报价请求，将其替换为另一个，或者如有必要，请将其无效。

支持文件提交是可选的。但是，希望支持此功能的税务提供商必须在何时与BigCommerce共享文档提交URL使用BigCommerce共享提供商详细信息。

如果支持文档提交，请导航到商店设置>税务> {税务提供商}并确保选中“提交订单数据”复选框。

查看提交税Quote API参考。

测试

在测试税务提供者之前，商家或合作伙伴测试商店应在BigCommerce控制面板中配置以下内容：

• 通过导航到的商店配置文件地址商店设置>商店配置文件配置了，所选国家/地区是纳税提供商支持的国家之一
• 通过导航到的运输原产地址商店设置>运输配置了。此值包含在税收估计请求中
• 税收提供者，通过导航来发现商店设置>税收已启用
• 如果支持文档提交，请导航到商店设置>税务> {税务提供商}并确保选中“提交订单数据”复选框

要测试纳税提供商连接，导航到商店设置>税务> {税务提供商}在BigCommerce控制面板中，然后单击测试连接。这将触发税务提供者提供的估算URL的示例税估计请求。如果连接不成功，用户可以导航到服务器设置>商店日志在BigCommerce控制面板中查看错误，并为其进行说明来帮助进行TRIAWAING问题。

支持

对于与BigCommerce应用程序有关的任何内容，请使用您的票据BigCommerce Dev Tools门户。

请参阅我们的税务提供商API参考这里有一个完整的API描述。

对于纳税提供商API相关的问题，或请求设置新的税务提供商配置，电子邮件taxproviderapi@bigcommerce.com.。

相关资源

文章

• 构建应用指南

终点

• 税务提供商API参考
• 获取税务提供商连接
• 删除税务提供商连接
• 更新税务提供商连接
• 税务课程