| 1. Sales Order |
Sales Order main API is used to interact with sales orders. It allows the user to add a new sales order or edit an existing one. You can also use it to view existing sales orders.
Functions
Add, Edit, Get
|
| 1.1. 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
}
|
| 1.2. Edit |
​Function
Sales Order Edit API is used to modify details in existing sales orders.
URL-{Root URL}/API/SO/Edit/{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-CUST 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
Edit Existing SO
URL- ?SoNo=SONO?custNo=CUSTNO?FOB=ORIGIN-SHIP
JSON-
{
'SoNo':'SONO',
'custNo':'CUSTNO',
'FOB':'ORIGIN-SHIP
}
A successful request returns the following
{
"$id":"1","Code":200,
"Message":"Sales Order edited 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/SOEdit/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'SOEdit'."
}
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 edit failed.Object reference not set to an instance of an object.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.3. Get |
​Function
Sales Order Get API is used to view details of existing sales orders.
URL-{Root URL}/API/SO/Get/{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-CUST 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
View SO
URL- ?SoNo=SONO
JSON-
A successful request returns the following
{
$id: "1",
Code: 200,
Message: "Sales Order details:",
SessionId: "41imqmhh3cywo2c2e5u1gzsu",
IsValidUser: true,
-ResponseObject: {
$id: "2",
-SODETAILList: [
-{
$id: "3",
DueDateList: [ ],
SOPRICESList: [ ],
UNIQUELN: "A6WDVN62YM",
UNIQ_KEY: "_44Y0WP6H4",
SONO: "0000000789",
LINE_NO: "0000002",
UOFMEAS: "each",
EACHQTY: 0,
ORD_QTY: 0,
SHIPPEDQTY: 0,
BALANCE: 0,
Sodet_Desc: "Loud ",
TRANS_DAYS: 1,
FSTDUEDT: "2014-11-13T00:00:00",
DELIFREQ: " ",
CATEGORY: "000000000~",
NOTE: "",
EXTENDED: 0,
BULLETIN: "",
WONOFLAG: false,
QTYFROMINV: 0,
STATUS: "STANDARD ",
W_KEY: "_4500WBEBA",
ORIGINUQLN: " ",
PRJUNIQUE: " ",
ARCSTATUS: " ",
PRODTPUNIQ: " ",
PRODTPUKLN: " ",
CNFGQTYPER: 0,
MRPONHOLD: false,
SOURCEINSP: false,
FIRSTARTCL: false,
LFCSTITEM: false,
LWARRANTY: false,
PART_NUM: null,
PRJCT_NUM: null,
REVISION: null
},
-{
$id: "4",
DueDateList: [ ],
SOPRICESList: [ ],
UNIQUELN: "ABDMRI2RMQ",
UNIQ_KEY: "_44Y0WP6H4",
SONO: "0000000789",
LINE_NO: "0000001",
UOFMEAS: "EACH",
EACHQTY: 2,
ORD_QTY: 20,
SHIPPEDQTY: 0,
BALANCE: 10,
Sodet_Desc: "Loud ",
TRANS_DAYS: 1,
FSTDUEDT: "2014-11-13T00:00:00",
DELIFREQ: "MO",
CATEGORY: "000000000~",
NOTE: "",
EXTENDED: 0,
BULLETIN: "",
WONOFLAG: false,
QTYFROMINV: 0,
STATUS: "STANDARD ",
W_KEY: "_4500WBEBA",
ORIGINUQLN: " ",
PRJUNIQUE: " ",
ARCSTATUS: " ",
PRODTPUNIQ: " ",
PRODTPUKLN: " ",
CNFGQTYPER: 0,
MRPONHOLD: false,
SOURCEINSP: false,
FIRSTARTCL: false,
LFCSTITEM: false,
LWARRANTY: false,
PART_NUM: null,
PRJCT_NUM: null,
REVISION: null
}
],
SONO: "0000000789",
BLINKADD: "_4560WJU2L",
SLINKADD: "_4560WL0MU",
CUSTNO: "0000000008",
SHIPNO: " ",
ORDERDATE: "2014-10-23T16:03:00",
TMPACK: false,
TMPACKDT: null,
TMPACKINIT: " ",
POACK: false,
POACKDT: null,
POACKINIT: " ",
PORECEIV: false,
POREINIT: " ",
POREDT: null,
PONO: " ",
CUSTWONO: " ",
SONOTE: "",
ORDPASSWD: " ",
FOB: "ORIGIN-CUST P/U",
SHIPVIA: "UPS-GRND TRACK ",
SHIPCHARGE: "PREPAY/BILL CUS",
IS_CLOSED: false,
DATECHG: null,
SOFOOT: "",
ORD_TYPE: "OPEN ",
DELIV_TIME: "15:30 ",
DELIV_AMPM: " ",
BUYER: " ",
SOAMOUNT: -12,
ATTENTION: " ",
GLDIVNO: " ",
IS_RMA: false,
ORIGINSONO: " ",
INVOICENO: " ",
SOAMTDSCT: 0,
SOEXTEND: 0,
SOTAX: 0,
PRINTPRDT: false,
SOAPPROVAL: false,
SOAPPRVINT: " ",
SOAPPRVDT: null,
SAVEINT: "NA ",
SAVEDT: "2014-10-23T16:03:00",
ACKPO_DOC: " ",
TERMS: "NET 15 ",
SOPTAX: 0,
SOSTAX: 0,
SOCHANGES: "",
BILLACOUNT: " ",
CustomerName: null,
CanApproveSo: false,
UserId: "00000000-0000-0000-0000-000000000000"
}
}
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/SOGet/123456789?SONO=800'.",
"MessageDetail": "No type was found that matches the controller named 'SOGet'."
}
API Key Error
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
Sales Order Does Not Exist
If the Sales Order Number entered does not refer to an existing sales order the system will return a "Sales Order does not exist" error message.
{
"$id": "1",
"Code": 403,
"Message": "Sales Order does not exists.",
"SessionId": "m2fhqbextbxo334fl4zg5ty0",
"IsValidUser": true,
"ResponseObject": null
}
|
|