Functions
Customer Tax get API is used to find and view existing tax information
URL:{Root URL}/API/ShipTax/Get/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| Linkadd |
Link to Ship Bill Table |
Y |
Links the tax info to the shipping info |
Example Strings
Get Tax Information
URL:?LinkAdd=LINKADD
JSON
A successful get request should result in
{
"$id": "1",
"Code": 200,
"Message": "ShipTax details:",
"SessionId": null,
"IsValidUser": true,
-"ResponseObject": [
-{
"$id": "2",
"ShipBill": null,
"UNQSHIPTAX": "_41X0YBZJX",
"LINKADD": "_41X0YBRKE",
"CUSTNO": "0000000007",
"ADDRESS1": " ",
"TAXDESC": "SANTA CLARA CNTY. USE TAX",
"TAXTYPE": "S",
"TAX_RATE": 8.25,
"TAX_ID": "CA USE ",
"RECORDTYPE": "S",
"PTPROD": false,
"PTFRT": false,
"STPROD": false,
"STFRT": false,
"STTX": false,
"ModifiedDate": null
},
{
"$id": "3",
"ShipBill": null,
"UNQSHIPTAX": "_41X0YC231",
"LINKADD": "_41X0YBRKE",
"CUSTNO": "0000000007",
"ADDRESS1": " ",
"TAXDESC": "SANTA CLARA CNTY. USE TAX",
"TAXTYPE": "C",
"TAX_RATE": 8.25,
"TAX_ID": "CA USE ",
"RECORDTYPE": "S",
"PTPROD": false,
"PTFRT": false,
"STPROD": false,
"STFRT": false,
"STTX": false,
"ModifiedDate": null
}
]
}
Common Errors
URL Error
If there is an error with the entered URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipTaxGet/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'ShipTaxGet'."
}
API Key Error
If there is a problem with the used API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
Parameter Error
If a required parameter is missing, or the entered value is incorrect the system will return an object reference error message.
{
"$id": "1",
"Code": 403,
"Message": "ShipTax does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
