| 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
}
|
|
|
|
|
|
|
|
|
| Article ID: 5825 |
