REST API for Oracle Commerce Cloud December 2017

listTaxProcessors

get

/ccadmin/v1/taxProcessors

List Tax Processors. Get a list of tax processors.

Request

Supported Media Types

application/json

Query Parameters

type: Type: string

Required: true

If set, only returns tax processor accounts of given tax processor type.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listTaxProcessors_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of tax processors.

Nested Schema : items

Type: array

The list of tax processors.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

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 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":null,
        "city":null,
        "defaultTaxRate":6,
        "postalCode":null,
        "hasPassword":false,
        "isActive":null,
        "type":"avalara",
        "enabled":false,
        "url":null,
        "fallbackEnabled":false,
        "merchantId":null,
        "addressLine1":null,
        "region":null,
        "showTaxSummary":true,
        "username":null
    },
    {
        "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| |------------------|------------------| |35003|If there is internal error while getting tax processor.| |35001|If no tax processor found with the given ID.|

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 Response Payload returned by endpoint:

[
  {
    "country": null,
    "city": null,
    "defaultTaxRate": 6,
    "postalCode": null,
    "hasPassword": false,
    "isActive": null,
    "type": "avalara",
    "enabled": false,
    "url": null,
    "fallbackEnabled": false,
    "merchantId": null,
    "addressLine1": null,
    "region": null,
    "showTaxSummary": true,
    "username": null
  },
  {
    "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"
  }
]