Customer Address delete API is used to remove customer address information from the customer record.
URL:{Root URL}/Api/ShipBill/Delete/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment
|
| Linkadd |
|
Y |
|
| Custno |
Customer Number |
N |
|
| Shipto |
Ship to Name |
N |
The person you are shipping to |
| Address1 |
First line of the address |
N |
|
| Address2 |
Second Line of the address |
N |
|
| City |
City |
N |
Ship to City |
| State |
State |
N |
Ship to State |
| Zip |
Zip Code |
N |
Ship to Zip code |
| Country |
Country |
N |
Ship to country |
| Phone |
Phone number |
N |
Ship to Phone Number |
| Fax |
Fax |
N |
Ship to fax address |
| Email |
Email |
N |
Ship to email address |
| Attention |
Attention |
N |
Attention notice for the shipping |
| recordtype |
The type of record |
N |
Can be C for Confirm to or R for Remit to |
Example Strings
Delete Address
URL:?LinkAdd=LINKADD
JSON
A successful delete should result in
{
"$id": "1",
"Code": 200,
"Message": "ShipBill deleted successfully.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Common Error
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
}
URL Error
If there is an issue 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/ShipBill/Delete/23456789'.",
"MessageDetail": "No action was found on the controller 'ShipBill' that matches the request."
}
Missing Required Parameter
If a required parameter is missing the system will return an error message specifying which parameter.
{
"$id": "1",
"Code": 403,
"Message": "Please provide LinkAddress",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|