API V1Essentials

Ping

If this call fails, API credentials are questionable.

Request

Ping Request
apiLoginIDstringRequired7-8 characters
Find your API ID via <a href="https://app.taxcloud.com/go/stores/" target="_blank">https://app.taxcloud.com/go/stores/</a>
apiKeystringRequired=8 characters
Find your API KEY via <a href="https://app.taxcloud.com/go/stores/" target="_blank">https://app.taxcloud.com/go/stores/</a>

Response

OK
ResponseTypeinteger or null

Response Types include <ul>

  • 0 = Error. Likely invalid API Credentials
  • 1 = Warning. Something is wrong.
  • 2 = Informational. Something could be better
    • <li>3 = SUCCESS! You did it!

    Messageslist of strings or null
    Optional array of messages related to the response.