1. Sales Order API

Sales Order API allows you to easily view and edit sales orders and the items related to the sales orders. 

1.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.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.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.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-

{

'SoNo':'SONO',

}

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

}

1.2. Edit
​Sales Order Item API is used to add, edit, delete, and view the items attached to sales orders

Functions

Add, Edit, Get, Delete

1.2.1. Add

Functions

Item Add API is used to add individual items to pre-existing Sales Orders.

URL-{Root URL}/API/SO/ItemADD/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y The Item's unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered N Amount of the item to add to the sales order
soDet_Desc Item Description Y
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliv_time Delivery Time Y Example: 3:00
note SO Item Note N Can be used to add a note to the item
status SO Item Status Y Can be 'Standard', 'Priority-1', 'Priority-2', 'Cancel', 'Closed'
w_key Warehouse Unique Record Identifier N Used if the item is a 'BUY' or 'MAKE' part. 

Example Strings

Add Part

URL-?SoNo=SONO?line_no=LINENUMBER?part_num=PARTNUMBER?revision=REVISION?soDet_Desc=DESCRIPTION?uOfMeas=EACH

JSON

{

'SONO':'SONO',

'line_no':'1=LINENUMBER',

'part_num':'PARTNUMBER',

'revision':'REVISION',

'sodet_desc':'DESCRIPTION',

'uofmeas':'EACH'

}

A successful request should return the following

{

"$id":"1",

"Code":200,

"Message":"Sales Order Item 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/SOItemAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOItemAdd'."

}

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 one of the entered parameters the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2.2. Edit

​Function

Sales Order Edit API is used to modify details about items in existing sales orders. 

URL-{Root URL}/API/SO/ItemEdit/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number Y You must provide either Line_no or UNIQUELN
part_num Part Number Y The part that is being added to the SO or are changing details of such as order qty or status etc. of that part number you provide
revision Part Revision Level Y If providing part number, you must provide Revision
uniq_key Item identifier N Can be used instead of part number and revision
uOfMeas Unit of Measurement N The Item"s unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered N Only required if changing Order Qty Amount
soDet_Desc Item Description N
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliFreq Delivery Frequency N Can be "DY", "WK", or "MO"
note SO Item Note N Can be used to add a note to the item
status SO Item Status N Only need if changing line item status : Can be "Standard", "Priority-1", "Priority-2", "Cancel", "Closed"
w_key Warehouse Unique Record Identifier N Used if the item is a "BUY" or "MAKE" part. 
UNIQUELN Unique Key for Line Item Y You must provide either Line_no or UNIQUELN

Example Strings

Edit Existing SO Item, Changing the Order Qty 

URL- ?SoNo=SONO&UNIQUELN=UNIQUELN&PART_NUM=PARTNUMBERrevision=REVISION&UOFMEAS=EACH&TRANSFER_DAYS=5 &ORD_QTY=20&EACHQTY=2&STATUS=STANDARD&DELIFREQ=MO

JSON-

{ 

"sono":"sales order number", 

"Line_no": "line item number", 

"Part_Num":"part number",

"revision":"revision",

"Ord_Qty":"40"

}

 

Edit Existing SO Item, Changing The status to "Admin Hold"

 

{ 

"sono":"Sales Order number", 

"Uniqueln": "UniqueLN", 

"Part_Num":"Partnumber",

"revision":"revision",

"status":"Admin Hold"

}

 

A successful request returns the following.

The below example I was adding more Order Quantity. 

 

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/SOItemEdit/123456789".",

"MessageDetail": "No type was found that matches the controller named "SOItemEdit"."

}

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 one of the entered parameters the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

 

Please Note:

If Line item balance is "0",  user cannot not edit Line Item Status without increasing the quantities also.

1.2.3. Get

​Function

Sales Order Item Get API is used to find and view details about items in existing sales orders. 

URL-{Root URL}/API/SO/ItemGet/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y The Item's unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered Y Amount of the item to add to the sales order
soDet_Desc Item Description Y
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliFreq Delivery Frequency N Can be 'DY', 'WK', or 'MO'
note SO Item Note N Can be used to add a note to the item
status SO Item Status Y Can be 'Standard', 'Priority-1', 'Priority-2', 'Cancel', 'Closed'
w_key Warehouse Unique Record Identifier N Used if the item is a 'BUY' or 'MAKE' part. 

Example Strings

Edit Existing SO

URL- ?UNIQUELN=UNIQUELN

JSON-

{

'UNIQUELN':'UNIQUELN'

}

A successful request returns the following

{

$id: "1",

Code: 200,

Message: "Sales Order Item details:",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

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

}

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an invalid API Key error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If the entered URL is invalid the system will return a "HTTP" error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOItemGet/23456789?UNIQUELN=_47D0OEV28'.",

"MessageDetail": "No type was found that matches the controller named 'SOItemGet'."

}

Item Does Not Exist

If the entered item does not exist the system will return an "Item Does Not Exist" error message.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order Item does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2.4. Delete

Functions

SO Item Delete API is used to remove items from existing sales orders.

URL-{Root URL}/API/SO/ItemDelete/{API KEY}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y The Item's unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered Y Amount of the item to add to the sales order
soDet_Desc Item Description Y
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliFreq Delivery Frequency N Can be 'DY', 'WK', or 'MO'
note SO Item Note N Can be used to add a note to the item
status SO Item Status Y Can be 'Standard', 'Priority-1', 'Priority-2', 'Cancel', 'Closed'
w_key Warehouse Unique Record Identifier N Used if the item is a 'BUY' or 'MAKE' part. 

Example Strings

Delete Item

URL-?SONO=SONO?uniqueln=UNIQUELN

JSON

{

'SONO':'SONO',

'uniqueln':'UNIQUELN'

}

A successful request should result in

{

"$id":"1",

"Code":200,

"Message":"Sales Order Item deleted successfully.",

"SessionId":null,

"IsValidUser":true,"

ResponseObject":null

}

Example Strings

Add Part

URL-?SoNo=SONO?line_no=LINENUMBER?part_num=PARTNUMBER?revision=REVISION?soDet_Desc=DESCRIPTION?uOfMeas=EACH

JSON

{

'SONO':'SONO',

'line_no':'1=LINENUMBER',

'part_num':'PARTNUMBER',

'revision':'REVISION',

'sodet_desc':'DESCRIPTION',

'uofmeas':'EACH'

}

A successful request should return the following

{

"$id":"1",

"Code":200,

"Message":"Sales Order Item 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/SOItemDelete/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOItemDelete'."

}

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 one of the entered parameters the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "UniqLn not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.3. Sales Order Item Price

Sales Order Item Price API is used to view, add, and modify price information for the items on the sales orders. 

Functions

Add, Edit, Get, Delete

1.3.1. Add

Functions

Add Item Price is used to add a price and price information to the items of a sales order.

URL-{Root URL}/API/SO/PriceAdd/{API Key}

Parameters

Parameter  Description Required Comment
SoNo Sales Order Number Y  
price Sales Order Price Y
taxable Is the SO Taxable N Can be 'true' or 'false'
flat
   
recordType      
saleTypeID Sales Type ID N Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM'
extended    
uniqueLn Unique Sales Order item identifier  Y Must be unique. 
plpricelink Price Link Key N Must be unique. 

Example Strings

 

Add Price

URL-?SoNo=SONO&uniqueln=UNIQUELN&price=1&taxable=1&flat=1&saletypeid=RESTOCKING

JSON

{

'SoNo':'785',

'uniqueln':'UNIQUELN',

'price':'1',

'taxable':'1',

'flat':'1',

'saletypeid':'RESTOCKING'

}

A successful add should return

{

$id: "1",

Code: 200,

Message: "Sales Order Price added successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceAdd/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOPriceAdd'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.3.2. Edit

Functions

Edit Item Price is used to modify a price or price information for the items of a sales order.

URL-{Root URL}/API/SO/PriceEdit/{API Key}

Parameters

Parameter  Description Required Comment
SoNo Sales Order Number Y  
price Sales Order Price Y
taxable Is the SO Taxable N Can be 'true' or 'false'
flat
   
recordType      
saleTypeID Sales Type ID N Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM'
extended    
uniqueLn Unique Sales Order item identifier  Y Must be unique. 
plpricelink Price Link Key N Must be unique. 

Example Strings

 

Add Price

URL-?SoNo=SONO&UNIQUELN=UNIQUELN&PLPRICELNK=PLPRICELNK&price=1.2&taxable=1&flat=1&saletypeid=RESTOCKING

JSON

{

'SoNo':'SONO',

'UNIQUELN':'UNIQUELN',

'PLPRICELNK':'PLPRICELNK',

'price':'1.2',

'taxable':'1',

'flat':'1',

'saletypeid':'RESTOCKING'

}

A successful request should return.

{

$id: "1",

Code: 403,

Message: "Sales Order Price edited successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceEdit/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOPriceEdit'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system an error message describing the parameter will be returned.

{

"$id": "1",

"Code": 403,

"Message": "PlPriceLnk not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.3.3. Get

Functions

Get Item Price is used to view price information of a sales order.

URL-{Root URL}/API/SO/PriceGet/{API Key}

Parameters

Parameter  Description Required Comment
SoNo Sales Order Number Y  
price Sales Order Price Y
taxable Is the SO Taxable N Can be 'true' or 'false'
flat
   
recordType      
saleTypeID Sales Type ID N Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM'
extended    
uniqueLn Unique Sales Order item identifier  Y Must be unique. 
plpricelink Price Link Key N Must be unique. 

Example Strings

 

Add Price

URL-?UNIQUELN=UNIQUELN

JSON

{

'UNIQUELN':'UNIQUELN',

}

A successful request should return.

{

$id: "1",

Code: 200,

Message: "Sales Order Price details:",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

PLPRICELNK: "GAWG8ODL6Q",

SONO: "0000000789",

DESCRIPTIO: "Loud ",

QUANTITY: 0,

PRICE: 1,

EXTENDED: 0,

TAXABLE: false,

FLAT: false,

RECORDTYPE: "P",

SALETYPEID: "RESTOCKING",

UNIQUELN: "A6WDVN62YM",

PL_GL_NBR: "4050000-00-00",

COG_GL_NBR: "5090000-00-00",

OrigPluniqLnk: " "

}

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceGet/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOPriceGet'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order Price does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.3.4. Delete

Functions

Delete Item Price is used to remove price information from a sales order.

URL-{Root URL}/API/SO/PriceDelete/{API Key}

Parameters

Parameter  Description Required Comment
SoNo Sales Order Number Y  
price Sales Order Price Y
taxable Is the SO Taxable N Can be 'true' or 'false'
flat
   
recordType      
saleTypeID Sales Type ID N Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM'
extended    
uniqueLn Unique Sales Order item identifier  Y Must be unique. 
plpricelink Price Link Key N Must be unique. 

Example Strings

 

Add Price

URL-?SoNo=SONO&UNIQUELN=UNIQUELN&PLPRICELNK=PLPRICELNK}

JSON

{

'SoNo':'SONO',

'UNIQUELN':'UNIQUELN',

'PLPRICELNK':'PLPRICELNK'

}

A successful request should return.

{

$id: "1",

Code: 200,

Message: "Sales Order Price deleted successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceDelete/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOPriceDelete'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order Price does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system an error message describing the parameter will be returned.

{

"$id": "1",

"Code": 403,

"Message": "PlPriceLnk not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4. Sales Order Item Due Date
1.4.1. Add

Functions

Add Item Due Date is used to add a due date to an item on the sales order.

URL-{Root URL}/API/SO/DueDateAdd/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
Due_DTS1 Due Dates Y Has to be working day. Enter in MM-DD-YYYY format
Ship_Dts Ship Date Y Has to be prior to Due Date. Enter in MM-DD-YYYY format.
commit_Dts Commit Date N Defaults from Due Dates, can also be entered manually. 
Qty Scheduled Quantity Y The total must be less than or equal to order quantity.
uniqueLn   Y  


Example Strings

 

Add Due Date

URL-?SONO=0000000000&UNIQUELN=UNIQUELN&QTY=QTY&DUE_DTS1=YYYY-MM-DD

JSON

{

'SONO':'0000000000',

'UNIQUELN':'UNIQUELN',

'QTY':'QTY',

'DUE_DTS1':'YYYY-MM-DD'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date added successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateAdd/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SODueDateAdd'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4.2. Edit

Functions

Due Date Edit API is used to change existing due dates on sales orders.

URL-{Root URL}/API/SO/DueDateEdit/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
Due_DTS1 Due Dates Y Has to be working day. Enter in YYYY-MM-DD format
Ship_Dts Ship Date Y Has to be prior to Due Date. Enter in YYYY-MM-DD format.
commit_Dts Commit Date N Defaults from Due Dates, can also be entered manually. 
Qty Scheduled Quantity Y The total must be less than or equal to order quantity.
uniqueLn   Y  

Example Strings

Edit Existing Schedule

URL:?dueDt_Uniq=DUEDT_UNIQ&SONO=0000000000&UNIQUELN=UNIQUELN&QTY=QTY&DUE_DTS1=YYYY-DD-MM

JSON

{

"dueDt_Uniq":"DUEDT_UNIQ",

"SONO":"0000000000",

"UNIQUELN":"UNIQUELN",

"QTY":"QTY",

"DUE_DTS1":"YYYY-MM-DD"

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date edited successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateEdit/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SODueDateEdit'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item Due Date.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system an error message describing the parameter will be returned.

{

"$id": "1",

"Code": 403,

"Message": "PlPriceLnk not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4.3. Get

Functions

Due Date Get API is used to view Due Date information from existing Sales Orders

URL-{Root URL}/API/SO/DueDateGet/{API Key}

Parameters

Parameter Description Required Comment
DueDateUniq Unique Due Date Identifier Y  


Example Strings

Get Due Date

URL:?DueDateUniq=DueDateUnique

JSON

{

'DueDateUniq':'DUEDATEUNIQUE'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date details:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": {

"$id": "2",

"DUEDT_UNIQ": "_3X60YA22D",

"SONO": "0000000709",

"DUE_DTS1": "2013-11-28T00:00:00",

"SHIP_DTS": "2013-11-26T00:00:00",

"COMMIT_DTS": "2013-11-28T00:00:00",

"QTY": 0,

"STDCHG": 0,

"PRICHG": 0,

"OTHCHG": 0,

"JOBPRI": " ",

"DAYMIN": 0,

"LOTNO": " ",

"QUOTE_SEL": false,

"START_DTS": null,

"ACT_SHP_QT": -1,

"ON_SCHED": false,

"COMPL_DTS": null,

"UNIQUELN": "_3X60Y9X2N"

}

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateGet/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SODueDateGet'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": ""$$Sales Order Due Date does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4.4. Delete

Functions

Sales Order Due Date Delete API is used to remove existing Due Dates from Existing Sales Orders

URL-{Root URL}/API/SO/DueDateDelete/{API Key}

Parameters

 Parameter Description Required Comment
DueDt_Uniq Unique Due Date Identifier Y  

Example Strings

Delete Schedule Information

URL-?DueDt_Uniq=DUEDT_UNIQ

JSON

{

'DueDt_Uniq':'DUEDT_UNIQ'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date deleted successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateDelete/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SODueDateDelete'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "DueDt_Uniq not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system an error message describing the parameter will be returned.

{

"$id": "1",

"Code": 403,

"Message": "DueDt_Uniq not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}