Customer Address add API is used to add Ship to Address and Bill to Address
URL:{Root URL}/Api/ShipBill/Add/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment
|
| Linkadd |
|
N |
|
| Custno |
Customer Number |
Y |
|
| 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
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 a 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 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 add failed.Customer does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
