updateTaxProcessor
put
/ccadmin/v1/taxProcessors/{id}
Update Tax Processor. Update a tax processor based on ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the tax processor to update.
Root Schema : updateTaxProcessor_request
Type:
Show Source
object
-
addressLine1(optional):
string
Address Line 1.
-
addressLine2(optional):
string
Address Line 2.
-
addressLine3(optional):
string
Address Line 3.
-
city(optional):
string
City name.
-
country(optional):
string
Country Name.
-
defaultTaxRate(optional):
number
Indicates the tax rate used in case of fallback
-
enabled:
boolean
Status if tax account is active.
-
fallbackEnabled(optional):
boolean
Indicates whether fallback tax calculation is enabled in case of failures
-
isActive(optional):
boolean
Status if tax account is active.
-
merchantId(optional):
string
Unique identifier of merchant.
-
password(optional):
string
Valid password for above username.
-
postalCode(optional):
string
Postal code.
-
region(optional):
string
Region or State name.
-
showTaxSummary(optional):
boolean
whether to show tax summary or not
-
type:
string
Name of the tax processor used.
-
url(optional):
string
Url of tax processor rest endpoint.
-
username:
string
Registered username with tax processor.
Example:
{
"country":"US",
"city":"alabama",
"defaultTaxRate":6,
"postalCode":"454455",
"type":"avalara",
"enabled":true,
"url":"https://development.avalara.net/1.0/tax/get",
"password":"asbde",
"fallbackEnabled":false,
"merchantId":"333",
"addressLine1":"abc",
"addressLine2":"abc",
"region":"al",
"showTaxSummary":true,
"username":"Karna"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateTaxProcessor_response
Type:
Show Source
object
-
addressLine1(optional):
string
Address Line 1.
-
addressLine2(optional):
string
Address Line 2.
-
addressLine3(optional):
string
Address Line 3.
-
city(optional):
string
City name.
-
country(optional):
string
Country Name.
-
defaultTaxRate(optional):
number
Indicates the tax rate used in case of fallback
-
fallbackEnabled(optional):
boolean
Indicates whether fallback tax calculation is enabled in case of failures
-
isActive(optional):
boolean
Status if tax account is active.
-
merchantId(optional):
string
Unique identifier of merchant.
-
password(optional):
string
Valid password for above username.
-
postalCode(optional):
string
Postal code.
-
region(optional):
string
Region or State name.
-
repositoryId(optional):
string
The ID of the tax processor item.
-
showTaxSummary(optional):
boolean
whether to show tax summary or not
-
type(optional):
string
Name of the tax processor used.
-
url(optional):
string
Url of tax processor rest endpoint.
-
username(optional):
string
Registered username with tax processor.
Example Response (application/json)
{
"country":"US",
"city":"alabama",
"defaultTaxRate":6,
"postalCode":"454455",
"hasPassword":true,
"type":"avalara",
"enabled":true,
"url":"https://development.avalara.net/1.0/tax/get",
"fallbackEnabled":false,
"merchantId":"333",
"addressLine1":"abc",
"addressLine2":"abc",
"region":"al",
"showTaxSummary":true,
"username":"Karna"
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|35004|If there is internal error while updating tax processor.|
|35001|If no tax processor found with the given ID.|
|40007|If active tax processor already exists.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code