REST API for Oracle Commerce Cloud December 2017

createTaxProcessor

post

/ccadmin/v1/taxProcessors

Create Tax Processor. Creates a new tax processor of given type and input params.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : createTaxProcessor_request

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"
}

Properties

addressLine1: Type: string

Required: true

Address Line 1.
addressLine2: Type: string

Address Line 2.
addressLine3: Type: string

Address Line 3.
city: Type: string

Required: true

City name.
country: Type: string

Required: true

Country Name.
defaultTaxRate: Type: number

Indicates the tax rate used in case of fallback
fallbackEnabled: Type: boolean

Indicates whether fallback tax calculation is enabled in case of failures
isActive: Type: boolean

Required: true

Status if tax account is active.
merchantId: Type: string

Required: true

Unique identifier of merchant.
password: Type: string

Required: true

Valid password for above username.
postalCode: Type: string

Required: true

Postal code.
region: Type: string

Required: true

Region or State name.
showTaxSummary: Type: boolean

Indicates whether tax summary will be shown or not.
type: Type: string

Required: true

Name of the tax processor used.
url: Type: string

Required: true

Url of tax processor rest endpoint.
username: Type: string

Required: true

Registered username with tax processor.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createTaxProcessor_response

Properties

addressLine1: Type: string

Address Line 1.
addressLine2: Type: string

Address Line 2.
addressLine3: Type: string

Address Line 3.
city: Type: string

City name.
country: Type: string

Country Name.
defaultTaxRate: Type: number

Indicates the tax rate used in case of fallback
fallbackEnabled: Type: boolean

Indicates whether fallback tax calculation is enabled in case of failures
hasPassword: Type: boolean

Indicates whether password is set or not.
isActive: Type: boolean

Status if tax account is active.
merchantId: Type: string

Unique identifier of merchant.
postalCode: Type: string

Postal code.
region: Type: string

Region or State name.
repositoryId: Type: string

The ID of the newly created tax processor item.
showTaxSummary: Type: boolean

whether to show tax summary or not
type: Type: string

Name of the tax processor used.
url: Type: string

Url of tax processor rest endpoint.
username: Type: string

Registered username with tax processor.

Example 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| |------------------|------------------| |500|If required property is missing, invalid or is assigned null value.| |35002|If there is internal error while creating tax processor.| |40007|If active tax processor already exists.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "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"
}

Sample Response Payload returned by endpoint:

{
  "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"
}