Jump to

• Request
• Response

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 ()

Root Schema : createTaxProcessor_request

Type: object

Show Source

• addressLine1: string
  Address Line 1.
• addressLine2(optional): string
  Address Line 2.
• addressLine3(optional): string
  Address Line 3.
• city: string
  City name.
• country: 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: boolean
  Status if tax account is active.
• merchantId: string
  Unique identifier of merchant.
• password: string
  Valid password for above username.
• postalCode: string
  Postal code.
• region: string
  Region or State name.
• showTaxSummary(optional): boolean
  Indicates whether tax summary will be shown or not.
• type: string
  Name of the tax processor used.
• url: string
  Url of tax processor rest endpoint.
• username: string
  Registered username with tax processor.

{
    "properties":{
        "country":{
            "description":"Country Name.",
            "type":"string"
        },
        "city":{
            "description":"City name.",
            "type":"string"
        },
        "defaultTaxRate":{
            "description":"Indicates the tax rate used in case of fallback",
            "type":"number"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "type":{
            "description":"Name of the tax processor used.",
            "type":"string"
        },
        "isActive":{
            "description":"Status if tax account is active.",
            "type":"boolean"
        },
        "url":{
            "description":"Url of tax processor rest endpoint.",
            "type":"string"
        },
        "password":{
            "description":"Valid password for above username.",
            "type":"string"
        },
        "fallbackEnabled":{
            "description":"Indicates whether fallback tax calculation is enabled in case of failures",
            "type":"boolean"
        },
        "merchantId":{
            "description":"Unique identifier of merchant.",
            "type":"string"
        },
        "addressLine1":{
            "description":"Address Line 1.",
            "type":"string"
        },
        "addressLine2":{
            "description":"Address Line 2.",
            "type":"string"
        },
        "addressLine3":{
            "description":"Address Line 3.",
            "type":"string"
        },
        "region":{
            "description":"Region or State name.",
            "type":"string"
        },
        "showTaxSummary":{
            "description":"Indicates whether tax summary will be shown or not.",
            "type":"boolean"
        },
        "username":{
            "description":"Registered username with tax processor.",
            "type":"string"
        }
    },
    "required":[
        "country",
        "city",
        "postalCode",
        "type",
        "isActive",
        "url",
        "password",
        "merchantId",
        "addressLine1",
        "region",
        "username"
    ],
    "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"
    }
}

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createTaxProcessor_response

Type: object

Show Source

• 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
• hasPassword(optional): boolean
  Indicates whether password is set or not.
• isActive(optional): boolean
  Status if tax account is active.
• merchantId(optional): string
  Unique identifier of merchant.
• postalCode(optional): string
  Postal code.
• region(optional): string
  Region or State name.
• repositoryId(optional): string
  The ID of the newly created 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.

{
    "properties":{
        "country":{
            "description":"Country Name.",
            "type":"string"
        },
        "city":{
            "description":"City name.",
            "type":"string"
        },
        "defaultTaxRate":{
            "description":"Indicates the tax rate used in case of fallback",
            "type":"number"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "hasPassword":{
            "description":"Indicates whether password is set or not.",
            "type":"boolean"
        },
        "type":{
            "description":"Name of the tax processor used.",
            "type":"string"
        },
        "isActive":{
            "description":"Status if tax account is active.",
            "type":"boolean"
        },
        "url":{
            "description":"Url of tax processor rest endpoint.",
            "type":"string"
        },
        "fallbackEnabled":{
            "description":"Indicates whether fallback tax calculation is enabled in case of failures",
            "type":"boolean"
        },
        "merchantId":{
            "description":"Unique identifier of merchant.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the newly created tax processor item.",
            "type":"string"
        },
        "addressLine1":{
            "description":"Address Line 1.",
            "type":"string"
        },
        "addressLine2":{
            "description":"Address Line 2.",
            "type":"string"
        },
        "addressLine3":{
            "description":"Address Line 3.",
            "type":"string"
        },
        "region":{
            "description":"Region or State name.",
            "type":"string"
        },
        "showTaxSummary":{
            "description":"whether to show tax summary or not",
            "type":"boolean"
        },
        "username":{
            "description":"Registered username with tax processor.",
            "type":"string"
        }
    }
}

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

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top