Skip to main content
POST
Test a merchant Avalara connection

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
avalara_account
object
required

The credential set to test. An omitted credential falls back to the stored slot for the environment.

Response

Success

authenticated
boolean
required

true only when Avalara's ping reported authenticated true. false for rejected credentials and when Avalara could not be reached; the message says which.

environment
enum<string>
required

The AvaTax environment that was called.

Available options:
sandbox,
production
company_code
object
required

The outcome of the company code lookup.

message
string
required

A merchant-facing explanation of the outcome. Never contains credentials.

status
enum<integer>
required
Available options:
200
meta
object
required