EliordiqService
EliordiqService.asmx
This web service is obseleted and has been replaced by OrderInquiry or InvoiceInquiry web service.
OrderInquiryCustomer
This Order Inquiry by Customer method will return orders or invoices for a customer.
Usage:
OrderInquiryCustomerResult = A.OrderInquiryCustomer(UserName, UserPassword, OrderInquiryCustomerInput)
Parameters UserName and UserPassword are not used at this moment.
OrderInquiryCustomerInput Structure
Property |
Length |
Type |
Upper |
Detail |
CustomerNo |
6 |
String |
Y |
Required. |
OrderInvoiceFlag |
1 |
String |
|
“1” (default): Return orders. “2”: Return invoices. |
SortingSeq |
1 |
String |
Y |
“A” (default): Sort result in ascending sequence or order or invoice number. “D”: Sort result in descending sequence of order or invoice number. |
ExcludePostFlag |
1 |
String |
Y |
This field only works when querying orders (i.e., OrderInvoiceFlag = “1”). “Y”: Exclude posted orders. “N” (default): Do not exclude posted orders. |
TableSize |
2 |
Integer |
|
This is the maximum number of orders to return. |
ChkHeaderNote |
1 |
String |
Y |
“Y”: Check if header note exists. If note exists for the order or invoice, then the value in OrderRecord().OrderNoteFlag will be set to “Y,” otherwise “N.” This can help you with the user interface since it gives the option to drill down to the associated notes. “N” (default): Do not check if header note exists. |
IncludeExcludeTypeFlag |
1 |
String |
Y |
This is used in conjunction with “IncludeExcludeOrderType,” which indicates the order types to be included or excluded. “I”: Include some types. “E”: Exclude some types. Blank: Include all types. |
IncludeExcludeOrderType |
3 |
String |
Y |
This is used in conjunction with “IncludeExcludeTypeFlag.” The value here is the order types to be included or excluded. Elliott supports the following order types: O (Order), I (Invoice), C (Credit Memo), Q (Quote) and B (Blanket Order). If you wish to display only the “O” and “I” type of orders, you can specify “I” in the previous field, and “OI” in this field. You can specify maximum 3 order types in this field. |
CutoffInvoiceDate |
|
Date |
|
Only return records with invoice date >= the value here. At your eCommerce site, you may not wish to return invoice history over 5 years. Then you can specify the cut-off date here. |
CutoffOrderDate |
|
Date |
|
Only return records with order date >= the value here. |
CutoffEnteredDate |
|
Date |
|
Only return records with entered date >= the value here. |
OrderInquiryCustomerResult Structure
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “EliordiqService Return Code” section. |
OrderRecord() |
OrderRecord |
An array of order records. See “OrderRecord Structure” for more detail. |
TableCount |
Integer |
Number of order or invoice records in OrderRecord array. |
OrderRecord Structure
Property Name |
Type |
Detail |
ORDER_DATE_ENTERED |
Date |
|
ORDER_DATE |
Date |
|
ORDER_INVOICE_DATE |
Date |
|
ORDER_SHIPPING_DATE |
Date |
|
ORDER_TYPE |
String |
|
OrderStatus |
String |
|
OrderHoldStatus |
String |
|
ORDER_NO |
Prior to V8.5: Integer V8.5 and Above: String |
|
ORDER_INVOICE_NO |
Prior to V8.5: Integer V8.5 and Above: String |
|
OrderPurchaseNo |
String |
|
ORDER_SHIP_TO_NO |
String |
|
ORDER_SHIP_VIA_CODE |
String |
|
ORDER_TERMS_CODE |
String |
|
ORDER_SALESMAN_NO_1 |
String |
|
ORDER_MFGING_LOC |
String |
|
ORDER_JOB_NO |
String |
|
ORDER_DATE_PICKED |
Date |
|
ORDER_CUSTOMER_NO |
String |
|
ORDER_BILL_TO_NAME |
String |
|
OrderBillToCity |
String |
|
OrderBillToState |
String |
|
OrderBillToZipCode |
String |
|
ORDER_SHIP_TO_NAME |
String |
|
OrderShipToCity |
String |
|
OrderShipToState |
String |
|
OrderShipToZipCode |
String |
|
ORDER_TOTAL_SALE_AMT |
Double |
|
ORDER_TOTAL_WEIGHT |
Double |
|
ORDER_MISC_CHRG_AMT |
Double |
|
ORD_FREIGHT_AMOUNT |
Double |
|
ORD_SALES_TAX_AMT_1 |
Double |
|
ORDER_COMM_PERCENT |
Double |
|
ORDER_COMM_AMOUNT |
Double |
|
ORDER_DATE_BILLED |
Date |
|
ORDER_POSTED_DATE |
Date |
|
ORDER_PART_PSTED_FLG |
String |
|
ORDER_EDI_FLAG |
String |
|
ORDER_STORE_NO |
String |
|
ORDER_BILL_TO_NO |
String |
|
ORDER_RMA_STATUS |
String |
|
ORDER_PHANTM_INV_FLG |
String |
|
ORDER_DEPT_NO |
String |
|
ORDER_BOL_PRINTED |
String |
|
ORDER_EDI_EXP_FLG |
String |
|
ORDER_SHIP_ACK_DATE |
Date |
|
ORDER_PICK_TICK_CUT |
Date |
|
OrderOrdExportedFlag |
String |
|
ORDER_SHIP_TO_XREF |
String |
|
ORDER_856_EXP_FLG |
String |
|
ORDER_ORD_ACK_SENT |
String |
|
OrderNoteFlag |
String |
|
MagnifestFlag |
String |
|
BoxTrackNo |
String |
|
BoxDate |
Date |
|
OrderReserved |
String |
This field is not used at the moment. |
Code Example (VB)
The following sample code will return orders for customer “000001,” cutoff date is 05/03/2010, and sort return records by order number in ascending sequence.
Dim Service As New webServicesordiq.EliordiqService
Dim Result As New webServicesordiq.OrderInquiryCustomerResult
Dim Input As New webServicesordiq.OrderInquiryCustomerInput
Input.CustomerNo = “000001”
Input.OrderInvoiceFlag = “1”
Input.SortingSeq = “A”
Input.CutoffOrderDate = New Date(2010,5,3)
Result = Service.OrderInquiryCustomer(“”, “”, Input)
If Result.ReturnCode = 0 Then
If Result.TableCount > 0 Then
lblResult.Text = “First Order No.=” & _
Result.OrderRecord(0).ORDER_NO.ToString & _
“ Order Type=” & Result.OrderRecord(0).ORDER_TYPE
Else
lblResult.Text = “No Matching Order.”
End If
Else
lblResult.Text = Result.ReturnCode.ToString
End If
This method will return orders or invoices for an item.
Usage:
OrderInquiryItemResult = A.OrderInquiryItem(UserName, UserPassword, OrderInquiryItemInput)
Parameters UserName and UserPassword are not used at this moment.
OrderInquiryItemInput Structure
Property |
Length |
Type |
Upper |
Detail |
ItemNo |
15 |
String |
Y |
Required. |
OrderInvoiceFlag |
1 |
String |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
SortingSeq |
1 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
ExcludePostFlag |
1 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
TableSize |
2 |
Integer |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
ChkHeaderNote |
1 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
ChkLineNote |
1 |
String |
Y |
“Y”: Check if line note exists. If line note exists, pass “Y” to LineItemRecord().LineItemNoteFlag, otherwise pass “N” to it. “N” (default): Do not check if line note exists. |
ChkLineSerial |
1 |
String |
Y |
“Y”: Check if the line item is serialized item, than pass “Y” or “N” to output LineItemRecord().LineItemSerialFlag. “N” (default): do not check if the line item is serialized item. |
ChkLineOption |
1 |
String |
Y |
“Y”: Check if the line item has line option, than pass “Y” or “N” to LineItemRecord().LineItemOptionFlag. “N” or blank (default): do not check if the line item has line option. |
ChkManifest |
1 |
String |
Y |
“Y”: Check for header manifest note, and than pass “Y” or “N” to OrderRecord().MagnifestFlag. “N” or blank (default): do not check for header manifest note. |
ReturnF2Comment |
1 |
String |
Y |
Some line items are actually comments added by F2 key. “Y”: Return line comments to LineItemRecord. “N” (default): Do not return line comments to LineItemRecord. |
IncludeExcludeTypeFlag |
1 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
IncludeExcludeOrderType |
3 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
CutoffInvoiceDate |
8 |
Date |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
CutoffOrderDate |
8 |
Date |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
CutoffEnteredDate |
8 |
Date |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
OrderInquiryItemResult Structure
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “EliordiqService Return Code” section. |
OrderRecord() |
OrderRecord |
This array contains order information. See “OrderRecord Structure” in OrderInquiryCustomer method for this property’s structure. |
LineItemRecord() |
LineItemRecord |
This array contains line item information. See the section below for this property’s structure. |
TableCount |
Integer |
Number of orders or invoices in OrderRecord array. |
LineItemRecord Structure
Property Name |
Type |
Detail |
LINE_ITM_ORDER_NO |
Prior to V8.5: Integer V8.5 and Above: String |
|
LINE_ITM_SEQ_NO |
Integer |
|
LineItemCustomerNo |
String |
|
LINE_ITM_ITEM_NO |
String |
|
LINE_ITM_DESC1 |
String |
|
LINE_ITM_DESC2 |
String |
|
LINE_ITM_QTY_ORDRD |
Double |
|
LINE_ITM_QTY_TO_SHIP |
Double |
|
LINE_ITM_QTY_BCK_ORD |
Double |
|
LINE_ITM_UNIT_PRICE |
Double |
|
LINE_ITM_DISC_PCT |
Single |
|
LINE_ITM_REQST_DATE |
Date |
|
LINE_ITM_PROMISE_DT |
Date |
|
LINE_ITM_PICK_SEQ |
String |
|
LINE_ITM_UOM |
String |
|
LINE_ITM_SERL_LOT_NO |
String |
|
LINE_QTY_RET_TO_STCK |
Double |
|
LINE_ITM_BACKORD_FG |
String |
|
LINE_ITM_UNIT_WEIGHT |
Double |
|
LINE_COMM_CALC_TYPE |
String |
|
LINE_COMM_PCT_OR_AMT |
Double |
|
LINE_ITM_TAXABLE_FG |
String |
|
LINE_ITM_STOCKED_FG |
String |
|
LINE_ITM_CONTRL_FG |
String |
|
LINE_ITM_SELECT_CD |
String |
|
LINE_TOTAL_QTY_SHIPD |
Double |
|
LINE_ITM_BM_ORDER_NO |
Prior to V8.5: Integer V8.5 and Above: String |
|
LINE_ITM_PO_XR_SEQNO |
Integer |
|
LINE_ITM_PROD_CATE |
String |
|
LINE_ITM_REASON_CODE |
String |
|
LINE_ITM_VENDOR_NO |
String |
|
LINE_ITM_ORG_ITM_NO |
String |
|
LineItemSerialFlag |
String |
“Y”: This is a serialized item. “N”: This is not a serialized item. |
LineItemNoteFlag |
String |
“Y”: This item has line note. “N”: This item does not have line note. |
LineItemOptionFlag |
String |
“Y”: This item has line option. “N”: This item does not have line option. |
LineItemReserved |
String |
|
ORD_LINE_LS_S_L_NO() |
String |
This field is not used at the moment. |
Code Example (VB)
The following sample code will return orders for item “049,” cutoff date is 05/03/2010, and sort return records by order number in ascending sequence. Check header note and line note are turned on in this inquiry.
Dim Service As New webServicesordiq.EliordiqService
Dim Result As New webServicesordiq.OrderInquiryItemResult
Dim Input As New webServicesordiq.OrderInquiryItemInput
Input.ItemNo = “049”
Input.OrderInvoiceFlag = “1”
Input.SortingSeq = “A”
Input.ChkHeaderNote = “Y”
Input.ChkLineNote = “Y”
Input.CutoffOrderDate = New Date(2010,5,3)
Result = Service.OrderInquiryItem(“”, “”, Input)
If Result.ReturnCode = 0 Then
If Result.TableCount > 0 Then
lblResult.Text = “First Order No.=” & _
Result.OrderRecord(0).ORDER_NO
If Result.LineItemRecord(0).LineItemNoteFlag = “Y”
lblResult.Text += “ And The Item Has a Note”
Else
lblResult.Text += “ And The Item Does Not Have a Note”
End If
Else
lblResult.Text = “No Matching Order.”
End If
Else
lblResult.Text = Result.ReturnCode.ToString
End If
This method will return orders or invoices by providing an order number.
Usage:
OrderInquiryOrderNoResult = A.OrderInquiryOrderNo(UserName, UserPassword, OrderInquiryOrderNoInput)
Parameters UserName and UserPassword are not used at this moment.
OrderInquiryOrderNoInput Structure
Property |
Length |
Type |
Upper |
Detail |
OrderNo |
6 |
Prior to V8.5: Integer V8.5 and Above: String |
|
Required. |
OrderInvoiceFlag |
1 |
String |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
SortingSeq |
1 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
ExcludePostFlag |
1 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
TableSize |
2 |
Integer |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
ChkHeaderNote |
1 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
ChkLineNote |
1 |
String |
Y |
See “OrderInquiryItemInput Structure” in OrderInquiryCustomer method. |
ChkLineSerial |
1 |
String |
Y |
See “OrderInquiryItemInput Structure” in OrderInquiryCustomer method. |
ChkLineOption |
1 |
String |
Y |
See “OrderInquiryItemInput Structure” in OrderInquiryCustomer method. |
ChkManifest |
1 |
String |
Y |
See “OrderInquiryItemInput Structure” in OrderInquiryCustomer method. |
ReturnF2Comment |
1 |
String |
Y |
See “OrderInquiryItemInput Structure” in OrderInquiryCustomer method. |
IncludeExcludeTypeFlag |
1 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
IncludeExcludeOrderType |
3 |
String |
Y |
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
CutoffInvoiceDate |
|
Date |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
CutoffOrderDate |
|
Date |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
CutoffEnteredDate |
|
Date |
|
See “OrderInquiryCustomerInput Structure” in OrderInquiryCustomer method. |
OrderInquiryOrderNoResult Structure
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “EliordiqService Return Code” section. |
OrderRecord() |
OrderRecord |
This array contains order information. See “OrderRecord Structure” in OrderInquiryCustomer method for this property’s structure. |
LineItemRecord() |
LineItemRecord |
This array contains line item information. See “LineItemRecord Structure” in OrderInquiryItem method for this property’s structure. |
TableCount |
Integer |
Number of orders or invoices in OrderRecord array. |
Code Example (VB)
The following sample code will return orders for order number 123456, cutoff date 05/03/2010, and sort return records by order number in ascending sequence. Check header note and line note are turned on in this inquiry.
Dim Service As New webServicesordiq.EliordiqService
Dim Result As New webServicesordiq.OrderInquiryOrderNoResult
Dim Input As New webServicesordiq.OrderInquiryOrderNoInput
Input.OrderNo = 123456
Input.OrderInvoiceFlag = “1”
Input.SortingSeq = “A”
Input.ChkHeaderNote = “Y”
Input.ChkLineNote = “Y”
Input.CutoffOrderDate = New Date(2010,5,3)
Result = Service.OrderInquiryOrderNo(“”, “”, Input)
If Result.ReturnCode = 0 Then
If Result.TableCount > 0 Then
lblResult.Text = “First Item No.=” & _
Result.LineItemRecord(0).LINE_ITM_ITEM_NO
If Result.LineItemRecord(0).LineItemNoteFlag = “Y”
lblResult.Text += “ And The Item Has a Note”
Else
lblResult.Text += “ And The Item Does Not Have a Note”
End If
Else
lblResult.Text = “No Matching Order.”
End If
Else
lblResult.Text = Result.ReturnCode.ToString
End If
0 = OK
1 = File Error
2 = Missing Customer No (Order Inquiry By Customer)
3 = Missing Item No (Order Inquiry By Item)
4 = Missing Order No (Order Inquiry By Order)
5 = Table Size Must < 30 (All Method)
6 = Sorting Sequence Must Be "A"((Ascending) or "D"(Descending)
7 = Include/Exclude Value Must Be Spaces, "I", or "E"
CLS