Function
The Customer Address Add API is used to add the ship-to address and bill-to address.
URL
{Root URL}/Api/ShipBill/Add/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | Linkadd | N | ||
| 2 | Custno | Customer number | Y | |
| 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
Add Address
URL
?custno=0000000000&shipTo=Test&recordType=S |
JSON
{ “custno”:”0000000000”, “shipTo”:”Test”, “recordType”:”S” } |
A successful add should result in:
{ "$id": "1", "Code": 200, "Message": "ShipBill added successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": { "$id": "2", "LINKADD": "056RU7J15B", "CUSTNO": "0000000010", "SHIPTO": "Test", "ADDRESS1": "", "ADDRESS2": "", "CITY": "", "STATE": "", "ZIP": "", "COUNTRY": "", "PHONE": "", "FAX": "", "E_MAIL": "", "TRANSDAY": "0", "FOB": "", "SHIPCHARGE": "", "SHIPVIA": "", "ATTENTION": "", "RECORDTYPE": "S", "BILLACOUNT": "", "SHIPTIME": "", "SHIPNOTE": "", "SHIP_DAYS": "0", "RECV_DEFA": "false", "CONFIRM": "", "PKFOOTNOTE": "", "INFOOTNOTE": "", "TAXEXEMPT": "", "FOREIGNTAX": "false", "ModifiedDate": "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/ShipBillAdd/123456789'.", "MessageDetail": "No type was found that matches the controller named 'ShipBillAdd'." } |
Parameter Value Error
If there is an error 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 add failed.Customer does not exist.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |