Function
The Customer Address Delete API is used to remove a customer's address information from the customer's record.
URL
{Root URL}/Api/ShipBill/Delete/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | Linkadd | Y | ||
| 2 | Custno | Customer number | N | |
| 3 | Shipto | Ship to name | N | The person you are shipping to. |
| 4 | Address1 | The first line of the address | N | |
| 5 | Address2 | The second line of the address | N | |
| 6 | City | City | N | Ship to city |
| 7 | State | State | N | Ship to state |
| 8 | Zip | Zip code | N | Ship to zip code |
| 9 | Country | Country | N | Ship to country |
| 10 | Phone | Phone number | N | Ship to phone number |
| 11 | Fax | Fax | N | Ship to fax address |
| 12 | N | Ship to email address | ||
| 13 | Attention | Attention | N | Attention notice for the shipping |
| 14 | recordtype | The type of record | N | Can be: "C" (for "Confirm to") or "R" (for "Remit to"). |
Example Strings
Customer Delete Address
URL
?LinkAdd=LINKADD |
JSON
{ "LinkAdd":"LINKADD" } |
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 message 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 an HTTP error message:
{ "$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 is missing:
{ "$id": "1", "Code": "403", "Message": "Please provide LinkAddress", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |