| Add |
Functions
Add API is used to add a new sales order
URL:{Root URL}/API/SO/Add/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| SoNo |
Sales Order Number |
Y |
Must be Unique. When adding a new sales order can be left blank. |
| custNo |
Customer Number |
Y |
Ten digits, padded to the left with '0' |
| blinkAdd |
Billing Link |
N |
> |
| slinkAdd |
Shipping Address Link |
N |
|
| orderDate |
Order Date |
Y |
Defaults to the Current date. Can be changed using MM-DD-YYYY forma |
| POAck |
Purchase Order Acknowledgement |
N |
Can be 1 or 0 |
| PoNo |
Purchase Order Number |
N |
Enter the purchase order number related to the sales order. |
| SONote |
Sales Order Note |
N |
User Input |
| FOB |
FOB |
N |
Can be ORIGIN-CUSTOMER P/U, ORIGIN-SHIP, DESTINATION |
| ShipVia |
Ship Via |
N |
Defaults with customer. Can be 'COMPANY TRUCK', 'CUST PICK UP', 'UPS-GRND TRACK', 'UPS-BLUE', 'UPS-RED', 'FEDX-P1', 'FEDX-STD'. |
| shipCharge |
Shipping Charge |
N |
Can be NO CHARGE, PREPAY/BILL CUS, SET RATE:UPS-BR, SET RATE:UPS-BL, SET RATE:UPS-RD, FEDX-1 |
| SoFoot |
Sales Order Footnote |
N |
User Entry, attaches a footnote to the Sales Order |
| DELIV_TIME |
Delivery Time |
N |
|
| Buyer |
Buyer Name |
N |
Must be a pre-existing customer. |
| ATTENTION |
Attention Person |
N |
Must Be a contact for the customer. |
| SOAMTDSCT |
Sales Order Discount |
N |
|
| SOAPPROVAL |
Sales Order Approval |
N |
Can be 0 or 1. If 1 must enter SOAPPRVINIT |
| SOAPPRVINIT |
Sales Order Approval Initial |
N |
Must be an approved user's initial. |
| SOAPPRVDT |
Sales Order Approval Date |
N |
System automatically uses the current date. |
| ACKPO_DOC |
Acknowledge PO Doc |
N |
Adds a PO acknowledge doc |
| TERMS |
Terms |
N |
Defaults from customer info, can be changed by user. |
| BILLACCOUNT |
Bill Account |
N |
System uses default from customer information, can be changed by user. |
Example Strings
New Sales Order, No items
URL- ?SoNo=SONO?custNo=CUSTNO
JSON-
{
'SoNo':'SONO',
'custNo':'CUSTNO'
}
A successful add returns the following
{
"$id":"1",
"Code":200,
"Message":"Sales Order added successfully.",
"SessionId":null,
"IsValidUser":true,
"ResponseObject":null
}
Common Errors
URL Error
If there is a problem with the URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOAdd/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'SOAdd'."
}
API Key Error
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
Parameter Error
If there is an error with a parameter the system will return an error message detailing the error.
{
"$id": "1",
"Code": 403,
"Message": "Sales Order add failed.Customer does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|