All URIs are relative to https://secure.ultracart.com/rest/v2
| Method | HTTP request | Description |
|---|---|---|
| deleteTaxProviderSelfCity | DELETE /tax/providers/self/city/{city} | Deletes a Self tax provider city |
| deleteTaxProviderSelfCountry | DELETE /tax/providers/self/country/{countryCode} | Deletes a Self tax provider country |
| deleteTaxProviderSelfCounty | DELETE /tax/providers/self/county/{county} | Deletes a Self tax provider county |
| deleteTaxProviderSelfPostalCode | DELETE /tax/providers/self/postalCode/{postal_code} | Deletes a Self tax provider postalCode |
| deleteTaxProviderSelfState | DELETE /tax/providers/self/state/{stateCode} | Deletes a Self tax provider state |
| getTaxProviderAnrok | GET /tax/providers/anrok | Retrieve the Anrok tax provider |
| getTaxProviderAnrokTest | GET /tax/providers/anrok/test | Attempts to connect to Anrok and returns back the response |
| getTaxProviderAvalara | GET /tax/providers/avalara | Retrieve the Avalara tax provider |
| getTaxProviderAvalaraCompanies | POST /tax/providers/avalara/companies | Returns Avalara Tax companies configured by the merchant |
| getTaxProviderAvalaraTest | GET /tax/providers/avalara/test | Attempts to connect to Avalara and returns back the response |
| getTaxProviderSelf | GET /tax/providers/self | Retrieve the Self tax provider |
| getTaxProviderSelfCountries | GET /tax/providers/self/countries | Retrieve the Self tax provider countries |
| getTaxProviderSelfRegionsByCountryCode | GET /tax/providers/self/regions/{countryCode} | Retrieve the Self tax provider regions for a given country code |
| getTaxProviderSovos | GET /tax/providers/sovos | Retrieve the Sovos tax provider |
| getTaxProviderSovosTest | GET /tax/providers/sovos/test | Attempts to connect to Sovos and returns back the response |
| getTaxProviderTaxJar | GET /tax/providers/taxjar | Retrieve the TaxJar tax provider |
| getTaxProviderTaxJarTest | GET /tax/providers/taxjar/test | Attempts to connect to TaxJar and returns back the response |
| getTaxProviderUltraCart | GET /tax/providers/ultracart | Retrieve the UltraCart tax provider |
| getTaxProviders | GET /tax/providers | Retrieve tax methods |
| setActiveTaxProvider | POST /tax/providers/setActive/{providerName} | Toggle a tax provider to active |
| updateTaxProviderAnrok | POST /tax/providers/anrok | Update the Anrok tax provider |
| updateTaxProviderAvalara | POST /tax/providers/avalara | Update the Avalara tax provider |
| updateTaxProviderSelf | POST /tax/providers/self | Update the Self tax provider |
| updateTaxProviderSelfCity | POST /tax/providers/self/city/{city} | Updates a Self tax provider city |
| updateTaxProviderSelfCountry | POST /tax/providers/self/country/{countryCode} | Updates a Self tax provider country |
| updateTaxProviderSelfCounty | POST /tax/providers/self/county/{county} | Updates a Self tax provider county |
| updateTaxProviderSelfPostalCode | POST /tax/providers/self/postalCode/{postal_code} | Updates a Self tax provider postalCode |
| updateTaxProviderSelfState | POST /tax/providers/self/state/{stateCode} | Updates a Self tax provider state |
| updateTaxProviderSovos | POST /tax/providers/sovos | Update the Sovos tax provider |
| updateTaxProviderTaxJar | POST /tax/providers/taxjar | Update the TaxJar tax provider |
| updateTaxProviderUltraCart | POST /tax/providers/ultracart | Update the UltraCart tax provider |
deleteTaxProviderSelfCity(city, taxCity)
Deletes a Self tax provider city
Deletes a Self tax provider city.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| city | String | The city being deleted. | |
| taxCity | TaxCity | tax city to be deleted |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
deleteTaxProviderSelfCountry(countryCode, taxCountry)
Deletes a Self tax provider country
Deletes a Self tax provider country.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| countryCode | String | The country code being deleted. | |
| taxCountry | TaxCountry | tax country to be deleted |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
deleteTaxProviderSelfCounty(county, taxCounty)
Deletes a Self tax provider county
Deletes a Self tax provider county.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| county | String | The county being deleted. | |
| taxCounty | TaxCounty | tax county to be deleted |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
deleteTaxProviderSelfPostalCode(postalCode, taxPostalCode)
Deletes a Self tax provider postalCode
Deletes a Self tax provider postalCode.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| postalCode | String | The postal code being deleted. | |
| taxPostalCode | TaxPostalCode | tax postal code to be deleted |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
deleteTaxProviderSelfState(stateCode, taxState)
Deletes a Self tax provider state
Deletes a Self tax provider state.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| stateCode | String | The state code being deleted. | |
| taxState | TaxState | tax state to be deleted |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderAnrok getTaxProviderAnrok()
Retrieve the Anrok tax provider
Retrieves the Anrok tax provider.
(No example for this operation).
This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderTestResult getTaxProviderAnrokTest()
Attempts to connect to Anrok and returns back the response
Attempts to connect to Anrok and returns back the response.
(No example for this operation).
This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderAvalara getTaxProviderAvalara()
Retrieve the Avalara tax provider
Retrieves the Avalara tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderAvalaraCompaniesResult getTaxProviderAvalaraCompanies(taxProviderAvalara)
Returns Avalara Tax companies configured by the merchant
Returns Avalara Tax companies configured by the merchant
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| taxProviderAvalara | TaxProviderAvalara | TaxProviderAvalara object |
TaxProviderAvalaraCompaniesResult
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderTestResult getTaxProviderAvalaraTest()
Attempts to connect to Avalara and returns back the response
Attempts to connect to Avalara and returns back the response.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderSelf getTaxProviderSelf()
Retrieve the Self tax provider
Retrieves the Self tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderSelfCountriesResponse getTaxProviderSelfCountries()
Retrieve the Self tax provider countries
Retrieves the Self tax provider countries.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
TaxProviderSelfCountriesResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderSelfRegionsResponse getTaxProviderSelfRegionsByCountryCode(countryCode)
Retrieve the Self tax provider regions for a given country code
Retrieves the Self tax provider regions for a given country code.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| countryCode | String | The country code regions desired. |
TaxProviderSelfRegionsResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderSovos getTaxProviderSovos()
Retrieve the Sovos tax provider
Retrieves the Sovos tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderTestResult getTaxProviderSovosTest()
Attempts to connect to Sovos and returns back the response
Attempts to connect to Sovos and returns back the response.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderTaxJar getTaxProviderTaxJar()
Retrieve the TaxJar tax provider
Retrieves the TaxJar tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderTestResult getTaxProviderTaxJarTest()
Attempts to connect to TaxJar and returns back the response
Attempts to connect to TaxJar and returns back the response.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderUltraCart getTaxProviderUltraCart()
Retrieve the UltraCart tax provider
Retrieves the UltraCart tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProvidersResponse getTaxProviders(limit, offset, expand)
Retrieve tax methods
Retrieves tax methods for this account.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100] |
| offset | Integer | Pagination of the record set. Offset is a zero based index. | [optional] [default to 0] |
| expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderActivateResult setActiveTaxProvider(providerName)
Toggle a tax provider to active
Toggle a tax provider to active.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| providerName | String | The tax provider to set active. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderAnrok updateTaxProviderAnrok(taxProviderAnrok)
Update the Anrok tax provider
Update the Anrok tax provider.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| taxProviderAnrok | TaxProviderAnrok | TaxProviderAnrok object |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderAvalara updateTaxProviderAvalara(taxProviderAvalara)
Update the Avalara tax provider
Update the Avalara tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| taxProviderAvalara | TaxProviderAvalara | TaxProviderAvalara object |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderSelf updateTaxProviderSelf(taxProviderSelf)
Update the Self tax provider
Update the Self tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| taxProviderSelf | TaxProviderSelf | TaxProviderSelf object |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxCity updateTaxProviderSelfCity(city, taxCity)
Updates a Self tax provider city
Updates a Self tax provider city.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| city | String | The city being updated. | |
| taxCity | TaxCity | tax city to be updated |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxCountry updateTaxProviderSelfCountry(countryCode, taxCountry)
Updates a Self tax provider country
Updates a Self tax provider country.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| countryCode | String | The country code being updated. | |
| taxCountry | TaxCountry | tax country to be updated |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxCounty updateTaxProviderSelfCounty(county, taxCounty)
Updates a Self tax provider county
Updates a Self tax provider county.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| county | String | The county being updated. | |
| taxCounty | TaxCounty | tax county to be updated |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxPostalCode updateTaxProviderSelfPostalCode(postalCode, taxPostalCode)
Updates a Self tax provider postalCode
Updates a Self tax provider postalCode.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| postalCode | String | The postal code being updated. | |
| taxPostalCode | TaxPostalCode | tax postal code to be updated |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxState updateTaxProviderSelfState(stateCode, taxState)
Updates a Self tax provider state
Updates a Self tax provider state.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| stateCode | String | The state code being updated. | |
| taxState | TaxState | tax state to be updated |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderSovos updateTaxProviderSovos(taxProviderSovos)
Update the Sovos tax provider
Update the Sovos tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| taxProviderSovos | TaxProviderSovos | TaxProviderSovos object |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderTaxJar updateTaxProviderTaxJar(taxProviderTaxJar)
Update the TaxJar tax provider
Update the TaxJar tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| taxProviderTaxJar | TaxProviderTaxJar | TaxProviderTaxJar object |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
TaxProviderUltraCart updateTaxProviderUltraCart(taxProviderUltracart)
Update the UltraCart tax provider
Update the UltraCart tax provider.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| taxProviderUltracart | TaxProviderUltraCart | TaxProviderUltraCart object |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |