Function
The Customer Address Edit API is used to modify existing customer address information.
URL
{Root URL}/Api/ShipBill/Edit/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | Linkadd | Y | ||
| 2 | Custno | Customer number | Y | |
| 3 | ShipCharge | Ship charge | Y | Can be: "NO CHARGE," "PREPAY/BILL CUS," "SET RATE:UPS-BR," "SET RATE:UPS-BL," '"SET RATE:UPS-RD," or "SET RATE:FEDX-1." |
| 4 | ShipVia | Ship via | Y | Can be: "COMPANY TRUCK," "CUST PICK UP," "UPS-GRND TRACK," "UPS-BLUE," "UPS-RED," "FEDX-1," or "FEDX-STD." |
| 5 | FOB | FOB | Y | Can be: "ORIGIN-CUST P/U," "ORIGIN-SHIP," or "DESTINATION." |
| 6 | Shipto | Ship to name | N | The person you are shipping to. |
| 7 | Address1 | The first line of the address | N | |
| 8 | Address2 | The second line of the address | N | |
| 9 | City | City | N | Ship to city |
| 10 | State | State | N | Ship to state |
| 11 | Zip | Zip code | N | Ship to zip code |
| 12 | Country | Country | N | Ship to country |
| 13 | Phone | Phone number | N | Ship to phone number |
| 14 | Fax | Fax | N | Ship to fax address |
| 15 | N | Ship to email address | ||
| 16 | Attention | Attention | N | Attention notice for the shipping |
| 17 | recordtype | The type of record | N | Can be "C" (for "Confirm to") or "R" (for "Remit to"). |
Example Strings
Customer Address Edit
URL
?LinkAdd=LINKADD&Custno=0000000000&Shipto=TestShipping&RecordType=B&Foreightax=false&FOB=ORIGIN-CUST P/U&SHIPCHARGE=PREPAY/BILL CUS&SHIPVIA=COMPANY TRUCK |
JSON
{ “LinkAdd”:”LINKADD”, “Custno”:”0000000000”, “Shipto”:”TestShipping”, “RecordType”:”B”, “Foreightax”:”false”, “FOB”:”ORIGIN-CUST P/U”, “SHIPCHARGE”:”PREPAY/BILL CUS”, “SHIPVIA”:”COMPANY TRUCK” } |
A successful edit should result in:
{ "$id": "1", "Code": "200", "Message": "ShipBill edited successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Common Errors
API Key Error
If there is an error with the entered API key, the system will return an error message describing an API key error:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
URL Error
If there is an error with the 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/ShipBillEdit/123456789'.", "MessageDetail": "No type was found that matches the controller named 'ShipBillEdit'." } |
Parameter Value Error
If there is a problem with one of the entered parameter values or a required parameter is missing, the system will return an error message describing the problem:
{ "$id": "1", "Code": "403", "Message": "ShipBill edit failed.Link address does not exists.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |