You must use the Commerce Cloud Admin API to enable the Vertex integration and configure its settings. You cannot set or view the Vertex integration details on the Tax Processing settings page in the administration console. 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.
Before you begin, make sure you have the taxpayer code, trusted ID, username, and password for your Vertex O Series account on hand.
In addition to information about your Vertex O Series account, you can configure the following settings:
Whether the list prices and sale prices for all products in your catalog include tax. If prices include tax, Vertex back-calculates taxes for each order.
Whether a tax summary will be shown on your store’s cart, checkout, and order summary. 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.
Note: Changing 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.
To configure the Vertex tax processing settings, issue a PUT request to /ccadminui/v1/taxProcessors/vertex-p.
The following table describes the properties for the request.
Property | Description |
|---|---|
| (Required) 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. |
| (Required) String that specifies the name of the city where your products ship from. |
| (Required) String that specifies your Vertex O Series taxpayer code. |
| (Required) String that specifies the country where your products ship from. |
| (Required) Boolean that specifies whether the tax processor is enabled for tax calculations on your store. |
| Boolean that specifies whether the list prices and sale prices for all products in your catalog include tax. If prices include tax, Vertex back-calculates taxes for each order. By default, the value of |
| (Required) String that specifies your Vertex O Series password. |
| (Required) 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. |
| (Required) String that specifies the name of the region, province, or state where your products ship from. |
| Boolean that specifies whether a tax summary will be shown on your store’s cart, checkout, and order summary. By default, the value of |
| (Required) A string that specifies your Vertex Trusted ID. |
| (Required) A string that specifies the tax processor to use. |
| (Required) String that specifies the dedicated host-instance URL you received from Vertex. |
| (Required) String that specifies your Vertex O Series username. |
The following example shows a PUT request that enables Vertex O Series as a store’s tax processor and configures the settings:
PUT /ccadminui/v1/taxProcessors/vertex-p HTTP/1.1
Content-Type: application/json
Authorization: Bearer <access_token>
{
"type": "vertex",
"enabled": true,
"company": "<vertex_taxpayer_code>",
"username": "<vertex_username>",
"password": "<vertex_password>",
"trustId":"<vertex_trustedId>",
"country": "USA",
"region": "MA",
"addressLine1": "1 Main St",
"city": "Cambridge",
"postalCode": "02142",
"url": "<dedicated_host_instance_url>",
"isTaxIncluded": false,
"showTaxSummary" : true,
}The following is the sample response body for this request:
{
"region": "MA",
"enabled": true,
"isTaxIncluded": false,
"links": [
{
"rel": "self",
"href":
"http://<occs_server>/ccadminui/v1/taxProcessors/vertex-p"
}
],
"showTaxSummary": true,
"type": "vertex",
"addressLine1": "1 Main St",
"url": "<dedicated_host_instance_url>",
"city": "Cambridge",
"country": "USA",
"isActive": false,
"username": "<vertex_username>",
"postalCode": "02142",
"company": "<vertex_taxpayer_code>",
"trustId": "<vertex_trustedId>",
"hasPassword": true
}
