Skip to main content

Integrating with Avalara

You can quickly and easily integrate Commerce with Avalara using the Integrations Hub in Commerce Manager. Using Avalara Integration, you can commit tax and void tax on specific order events.

Order changes in Commerce, like creating, fulfilling, and canceling, generate webhook events that cause orders to be created, fulfilled, and canceled in Avalara. The following Commerce event types can be used to generate webhook events.

  • order.created
  • order.fulfilled
  • order.paid
  • order.authorized
  • order.cancelled

Avalara Integration

note

When integrating with third-party providers, we recommend you use the closest region in the third-party service to reduce latency as much as possible. See Regions and URLs table.

Prerequisites​

You must have products in Commerce Manager.

Configuring Avalara Integration​

  1. In Commerce Manager, go to COMPOSER > Integrations Hub.

  2. Under Tax and Shipping, click Avalara.

  3. Click Configure. The Avalara integration guides you through the steps you need to follow to complete the integration.

  4. Click Next. The Connection page is displayed.

  5. Enter the following details in Avalara Connection:

    • Company Code - Your company code.
    • Avalara APP Version - Enter your API version. Default is 1.0.
    • Avalara Environment - Select either Sandbox or Production.
    • Avalara UserName - Your Avalara username.
    • Avalara Password - Your Avalara password.

  6. Enter the following details in Commerce Connection:

    • Client-ID - Your Commerce Client ID.
    • Client-Secret - Your Commerce Client Secret.
    • Token URL - Your Commerce API Token URL.

    Token URL for:

    • EU - https://useast.api.elasticpath.com/oauth/access_token
    • US - https://useast.api.elasticpath.com/oauth/access_token

    To collect your Client-ID and Client-Secret, log into Commerce Manager with Seller Admin privileges and go to SYSTEM > Application Keys. See Application Keys.

  7. Click Connect. The authorization is successfully completed.

  8. Click Next.

  9. In the Commit Trigger field, select one of the following order events according to your requirements to initiate the commit transaction:

    • order.created
    • order.fulfilled
    • order.paid
    • order.authorized

  10. (Optional) Turn on the Enable Ship from toggle to enter the ship from address. It is enabled by default.

  11. (Optional) In the ship from address field, click Edit and enter the ship from address.

  12. In the Default Tax Code field, enter your default tax code if your product doesn’t have an associated tax code.

  13. Click Next. You can see the default Commit Tax Template and Void Tax Template fields.

  14. (Optional) Click Edit to modify Commit Tax Template and Void Tax Template according to your requirements.

  15. Click Next. The Setup Webhooks and flows page is displayed. From this page, decide which webhooks you want to setup, depending on your requirements. The Avalara Integration automatically creates the webhooks, once you have finished configuring the integration.

    The following toggles are enabled by default:

    • Enable Commit webhook : triggers commit transaction
    • Enable Void webhook : triggers void transaction
    • Enable Product extension : configures product extension flow in Commerce Manager

  16. (Optional) Click Edit in the Product extension input field, to edit the default request in order to setup product extension flow and fields in Commerce depending on your requirements. This integration will create a new template and field in Commerce Manager.

  17. (Optional) Click Edit, in the Customer extension input field, to edit the default request in order to setup customer extension flow and fields in Commerce depending on your requirements.

  18. Click Finish. Your integration is enabled.

    The new template and atrributes will be displayed on the Configuration > Templates page. Additionally, customer extension flow and fileds are also displayed on SYSTEM > Flows page.

Using Avalara Integration​

The following scenario explains how to pay for an order in Elastic Path Composable Frontend and how you can commit tax and void tax using the Avalara integration.

  1. Go to Elastic Path Composable Frontend. It should be integrated with your store in Commerce Manager.

  2. Add a product to a cart. In Order Summary, you will see that tax has not been included in the order.

  3. Click Checkout.

  4. Enter your Contact Information and Shipping Address.

  5. Select the Same as shipping address checkbox if your Billing Address is same as Shipping Address

  6. Click Checkout Now.

    In Order Summary, you can now see that the tax has been calculated based on the shipping address.

  7. Enter your billing information and click Pay now to complete your transaction.

  8. Copy Your order number from the Order Complete page.

  9. In Commerce Manager, go to Store > Orders. All orders in the store are displayed.

  10. On the All orders page, click on your order to view the tax details.

  11. Log into your Avalara environment.

  12. Go to Transactions and search for your order.

    You can see the transaction details and tax summary, and the Document status shows Committed.

  13. (Optional) If you cancel an order in Commerce Manger, the Document status in Avalara environment will change to Voided.

Demos​

To learn how to configure and use the Avalara Integration, watch the following video: