Function
The Customer Address Get API is used to find and view existing customer address information.
URL
{Root URL}/Api/ShipBill/Get/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | Linkadd | Customer address key | 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 Get Address
URL
LinkAdd=LINKADD |
JSON
{ "LinkAdd","LINKADD" } |
A successful request should return the following:
{ "$id": "1", "Code": "200", "Message": "ShipBill details:", "SessionId": "null", "IsValidUser": "true", "ResponseObject": { "$id": "2", "LINKADD": "_4560WJU2L", "CUSTNO": "0000000008", "SHIPTO": "TestShipping ", "ADDRESS1": "12 West St ", "ADDRESS2": " ", "CITY": "Swilton ", "STATE": "NH ", "ZIP": "02343 ", "COUNTRY": "USA ", "PHONE": "6035555555 ", "FAX": " ", "E_MAIL": "", "TRANSDAY": "0", "FOB": "ORIGIN-CUST P/U", "SHIPCHARGE": "PREPAY/BILL CUS", "SHIPVIA": "COMPANY TRUCK ", "ATTENTION": " ", "RECORDTYPE": "B", "BILLACOUNT": " ", "SHIPTIME": " ", "SHIPNOTE": "", "SHIP_DAYS": "0", "RECV_DEFA": "false", "CONFIRM": " ", "PKFOOTNOTE": "", "INFOOTNOTE": "", "TAXEXEMPT": " ", "FOREIGNTAX": "false", "ModifiedDate": "2014-12-01T09:31:36.737" } } |
Common Errors
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 a problem with the entered URL, the system will return an HTTP error:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipBill/Get/123456789'.", "MessageDetail": "No action was found on the controller 'ShipBill' that matches the request." } |
Parameter Error
If the entered parameter does not link to an existing ship-bill record, the system will return a "ShipBill does not exist" error message:
{ "$id": "1", "Code": "403", "Message": "ShipBill does not exist.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |