| 1. Customer Address |
Customer Address API is used to add or modify shipping and billing addresses for customers. The Get function is used to view addresses for a customer. The delete function is used to remove addresses from a customer's information.
|
| 1.1. Add |
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
}
|
| 1.2. Edit |
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
|
| Linkadd |
|
Y |
|
| Custno |
Customer Number |
Y |
|
| ShipCharge |
Ship Charge |
Y |
Can be NO CHARGE, PREPAY/BILL CUS, SET RATE:UPS-BR, SET RATE:UPS-BL, SET RATE:UPS-RD, SET RATE:FEDX-1 |
| ShipVia |
Ship Via |
Y |
Can be COMPANY TRUCK, CUST PICK UP, UPS-GRND TRACK, UPS-BLUE, UPS-RED, FEDX-1, FEDX-STD |
| FOB |
FOB |
Y |
Can be ORIGIN-CUST P/U, ORIGIN-SHIP, DESTINATION |
| 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
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 a 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
}
|
| 1.3. Delete |
Customer Address delete API is used to remove customer address information from the customer record.
URL:{Root URL}/Api/ShipBill/Delete/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment
|
| Linkadd |
|
Y |
|
| Custno |
Customer Number |
N |
|
| 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
Delete Address
URL:?LinkAdd=LINKADD
JSON
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 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 a HTTP error
{
"$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.
{
"$id": "1",
"Code": 403,
"Message": "Please provide LinkAddress",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.4. Get |
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
|
| Linkadd |
Customer Address Key |
Y |
|
| Custno |
Customer Number |
N |
|
| 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
Get Address
URL:?LinkAdd=LINKADD
A successful request should return
{
"$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 exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|