To configure the external tax processor integration, you must supply your unique merchant ID. You can enable the external tax processer integration and configure its settings either on the Tax Processing settings page in the Commerce Cloud administration interface or with the Commerce Cloud Admin API.
Configure tax processing settings with the administration interface
This section describes how to configure integration settings for external tax processors in the Commerce Cloud administration interface.
To configure the settings for an external tax processor:
Click the menu icon and select Settings.
Select Tax Processing from the Settings list to display the Tax Processing page.
Select External from the Tax Processor list and select the Enable Tax Processor checkbox.
(Optional) Select Show Tax Summary to display an order’s tax amount in the cart, checkout, and order summary pages, or deselect it to hide the tax summary. This checkbox is selected by default.
If your store’s prices include tax, such as VAT, you likely do not want to display the tax summary. However, if prices to not include tax, you should always display a tax summary.
This setting has no effect on the display of the tax summary in the emails your store sends to customers. To learn how to remove the tax summary line from the order summaries in emails, see Customize tax display in templates.
Enter your Merchant ID.
This page does not ask for a URL or account login information, as you specify those when you configure the webhook. See Configure the External Tax Calculation webhook.
Enter your Ship from Warehouse Location settings.
If you run multiple sites within a single instance of Commerce Cloud, each site can have its own ship-from address. See Configure Ship from Warehouse Locations in Using Oracle Commerce Cloudfor more information.
Click Save.
The following table describes the Merchant ID and Ship-From Warehouse Location properties.
Configure tax processing settings with the Admin API
This section describes how to configure tax processing settings with the Admin API. See Use the REST APIs for information you need to know before you start working with the Admin API, including how to get an access token to make API requests.
If you run multiple sites within a single instance of Commerce Cloud, each site can have its own ship-from address. The ship-from address is a property of the site object, even if your Commerce Cloud instance runs only a single site. In previous releases, the ship-from address was a property of the taxProcessor object. See Configure a ship-from address for more information.
To configure the settings for an external tax processor, issue a PUT request to /ccadmin/v1/taxProcessors/external.
The following table describes the properties for the request.
Property | Description |
|---|---|
| String that specifies your Vertex O Series taxpayer code. |
| Boolean that specifies whether the tax processor is enabled for tax calculations on your store. |
| Boolean that specifies whether a tax summary will be shown on your store’s cart, checkout, and order summary. By default, the value of If your store’s prices include tax, such as VAT, you likely do not want to display the tax summary. However, if prices to not include tax, you should always display a tax summary. This setting has no effect on the display of the tax summary in the emails your store sends to customers. To learn how to remove the tax summary line from the order summaries in emails, see Customize tax display in templates. |
| A string that specifies the tax processor to use. The value must be |
The following example shows a PUT request that enables an external tax processor. Note that the request does not include a URL or account login information, as you specify those when you configure the webhook. See Configure the External Tax Calculation webhook for more information. This sample request also sets fallback tax calculation settings that Commerce Cloud uses if it cannot reach your tax processor, for example, in the event of an outage. See Monitor tax processors for more information.
PUT /ccadmin/v1/taxProcessors/external-p HTTP/1.1
Content-Type: application/json
Authorization: Bearer <access_token>
{
"enabled": true,
"showTaxSummary": true,
"type": "external",
"fallbackEnabled": true,
"defaultTaxRate": 5,
"fallbackRequestVolumeThreshold": 2,
"fallbackTimeThreshold": 60000,
"fallbackSleepWindow": 5000
}The following is the sample response body for this request. Commerce Cloud returns properties for a warehouse ship-from address, even though you do not set them on the taxProcessors object. See Configure a ship-from address for more information.
{
"country": null,
"isTaxIncluded": false,
"fallbackRequestVolumeThreshold": 2,
"city": null,
"defaultTaxRate": 5,
"postalCode": null,
"hasPassword": false,
"type": "external",
"isActive": false,
"url": null,
"enabled": false,
"fallbackTimeThreshold": 60000,
"fallbackEnabled": true,
"merchantId": 12345,
"fallbackSleepWindow": 5000,
"addressLine1": null,
"region": null,
"showTaxSummary": true,
"username": null
}Configure a ship-from address
If you run multiple sites within a single instance of Commerce Cloud, each site can have its own address from which items are shipped. For example, suppose you run two sites, one that sells items in the United States, and another that sells items in France. For the US store, items would ship from your warehouse in Chicago; for the French store, items would ship from your warehouse in Paris. The ship-from address is specified by the shipFromAddress property of the site object, even if your Commerce Cloud instance runs only a single site. See Configure Sites for more information about working with site objects.
In previous releases, the ship-from properties were stored on the taxProcessor object. If you integrated with Avalara AvaTax, Vertex O Series, or an external tax processor in a previous release and configured a ship-from address, Commerce Cloud automatically adds the address to the default site in this release. If you do not specifically configure a ship-from address for a site, the site automatically inherits the address used for the default site.
To configure the ship-from address for a site, issue a PUT request to /ccadmin/v1/sites/{id}.
The following table describes the properties for the request.
Property | Description |
|---|---|
| String that specifies the first line of the address where your products ship from. |
| String that specifies the second line of the address where your products ship from. |
| String that specifies the third line of the address where your products ship from. |
| String that specifies the name of the city where your products ship from. |
| String that specifies the country where your products ship from. |
| String that specifies the postal/ZIP code for the address where you products ship from. For addresses in the United States, use the nine-digit ZIP+4 code for best results. |
| String that specifies the name of the region, province, or state where your products ship from. |
The following example shows a PUT request that configures the ship-from address for a site.
PUT /ccadmin/v1/sites/100002 HTTP/1.1
Authorization: Bearer <access_token>
x-ccasset-language: en
{
"properties": {
"shipFromAddress": {
"city": "cambridge",
"addressLine1": "2 Main Street",
"country": "US",
"region": "WA",
"postalCode": "12345"
}
}
}Note that this call modifies the productionURL property only for the specified site, but also modifies defaultLocaleId, which is a global property, on all sites.
