APIs TaxRate REST API
Resource URL Summary
Retrieve the details of the Tax Rate for the specific Zip Code
GET /seiapi/v3/trans/TaxRate/PostalCode/${ZipCode}
Insert or Update the details of the Tax Rate for the specific Zip Code
PUT /seiapi/v3/trans/TaxRate/PostalCode/${ZipCode}
Bulk Insert or Update details of the Tax Rates for specific Zip Codes
PUT /seiapi/v3/trans/TaxRates
Delete the Tax Rate for the specific Zip Code
DELETE /seiapi/v3/trans/TaxRate/PostalCode/${ZipCode}
Bulk Delete Tax Rates for specific Zip Codes
DELETE /seiapi/v3/trans/TaxRates
API Specific Parameters
Parameter | Description |
---|---|
| The Zip Code the Tax Rate is associated with. |
HTTP Headers
This API uses the default ServiceMobility HTTP Headers.
API Specifics
Retrieve the details of the Tax Rate for the specific Zip Code
This REST API will return the Tax Rate for the specified Zip Code. The Tax Rate for the specified Zip Code must already exist in the system.
URL
GET /seiapi/v3/trans/TaxRate/PostalCode/${ZipCode}
HTTP Request Body
This request does not require a request body.
HTTP Response Body
On success, an HTTP response code of 200 will be returned, and the response body will contain a TaxRate Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
Insert or Update the details of a the Tax Rate for the specific Zip Code
This REST API will insert a new Tax Rate for specified Zip Code into the system, if a Tax Rate for the specified Zip Code does not already exist in the system.
If, however, the Tax Rate for the specified Zip Code does already exist in the system, then this REST API will update (i.e. replace) the already existing Tax Rate for the specified Zip Code with the details of the Tax Rate supplied in the HTTP Request Body.
URL
PUT /seiapi/v3/trans/TaxRate/PostalCode/${ZipCode}
HTTP Request Body
The HTTP request body must contain a valid TaxRate Object.
HTTP Response
On success the API will return a response code of 200.
Bulk Insert or Update details of the Tax Rates for specific Zip Codes
This REST API will insert new Tax Rates for specified Zip Codes into the system, if the Tax Rates for the specified Zip Codes do not already exist in the system.
If, however, the Tax Rates for the specified Zip Codes do already exist in the system, then this REST API will update (i.e. replace) the already existing Tax Rates for the specified Zip Codes with the details of the Tax Rates supplied in the HTTP Request Body.
URL
PUT /seiapi/v3/trans/TaxRates
HTTP Request Body
The HTTP request body must be a JSON array of the following objects, which incorporate a Zip Code and a standard TaxRate Object OrderTypes
array definition.
HTTP Response
On success the API will return a response code of 200.
Delete a the Tax Rate for the specific Zip Code
This REST API will delete the Tax Rate for the specified Zip Code from the system. The Tax Rate for the specified Zip Code must already exist in the system.
URL
DELETE /seiapi/v3/trans/TaxRate/PostalCode/${ZipCode}
HTTP Request Body
This request does not require a request body.
HTTP Response
On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent TaxRate Object.
Bulk Delete Tax Rates for specific Zip Codes
This REST API will delete Tax Rates for the specified Zip Codes from the system. The Tax Rates for the specified Zip Codes must already exist in the system.
URL
DELETE /seiapi/v3/trans/TaxRates
HTTP Request Body
The HTTP request body must be a JSON array of the following objects, which incorporate a Zip Code and a standard TaxRate Object OrderTypes
array definition.
HTTP Response
On success the API will return a response code of 200.