Purchase Order, Query
Queries existing Purchase Orders using the provided criteria and returns a list of found Purchase Orders.
URL
/api/purchase-order-query
Request Method
POST
Expandable Program
Purchase Order Editor (POEOE)
Required Fields
HEADER:
(at least one field to be used as query criteria if none in LINES)
AUTH_TOKEN
LINES:
(at least one field to be used as query criteria if none in HEADER)
(at least one field to be used as query criteria if none in LINES)
AUTH_TOKEN
LINES:
(at least one field to be used as query criteria if none in HEADER)
Auth Token
This API call requires an Authentication Token ("Auth Token") for the required field AUTH_TOKEN. Auth Tokens are obtained from Auth Token, Get.
Example Request JSON
{
"VENDOR_ID": "XYZCORP",
"LINES": {
"PART_ID": "MOTOR003"
},
"AUTH_TOKEN": ""
}Full Request JSON
{
"PO_ID": "",
"PO_TYPE": "",
"VENDOR_ID": "",
"VENDOR_NAME": "",
"ORDER_DATE": "",
"ORDER_CLASS": "",
"CHANGE_NO": "",
"CHANGE_DATE": "",
"CHANGE_CODE": "",
"DROP_SHIP_ID": "",
"BILL_TO_ID": "",
"CONFIRMED_TO": "",
"REFERENCE": "",
"BLANKET_ID": "",
"TERMS_CODE": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"TAX_CODE": "",
"BUYER_ID": "",
"ORDER_DISC_PCT": "",
"CURR_CODE": "",
"CURR_RATE": "",
"PO_HOLD": "",
"PO_STATUS": "",
"DATE_LAST_PRINT": "",
"POFOM_USER_1": "",
"POFOM_USER_2": "",
"POFOM_USER_3": "",
"POFOM_USER_4": "",
"POFOM_USER_5": "",
"POFOM_USER_6": "",
"POFOM_USER_7": "",
"POFOM_USER_8": "",
"POFOM_USER_9": "",
"POFOM_USER_10": "",
"POFOM_USER_11": "",
"POFOM_USER_12": "",
"POFOM_USER_13": "",
"POFOM_USER_14": "",
"POFOM_USER_15": "",
"POFOM_USER_16": "",
"POFOM_USER_17": "",
"POFOM_USER_18": "",
"POFOM_USER_19": "",
"POFOM_USER_20": "",
"POFOM_USER_21": "",
"POFOM_USER_22": "",
"POFOM_USER_23": "",
"POFOM_USER_24": "",
"POFOM_USER_25": "",
"POFOM_USER_26": "",
"POFOM_USER_27": "",
"POFOM_USER_28": "",
"POFOM_USER_29": "",
"POFOM_USER_30": "",
"POFOM_USER_31": "",
"POFOM_USER_32": "",
"POFOM_USER_33": "",
"POFOM_USER_34": "",
"POFOM_USER_35": "",
"POFOM_USER_36": "",
"POFOM_USER_37": "",
"POFOM_USER_38": "",
"POFOM_USER_39": "",
"POFOM_USER_40": "",
"PO_LIMIT_AMT": "",
"PO_EXPIRATION": "",
"LAST_REL_ID": "",
"TOTAL_RELEASES": "",
"TOTAL_REL_AMT": "",
"DATE_LAST_EDI": "",
"ORIG_PO_AMT": "",
"REVISED_PO_AMT": "",
"PAYMENTS_MADE": "",
"E_MAIL": "",
"E_MAIL_DATE": "",
"CHANGE_NO_EDI": "",
"PO_EXPIRE_DATE": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"NUMBER_BOXES": "",
"TOTAL_BOXES": "",
"PO_ORDER_CAT": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"TIME_LAST_UPDT": "",
"DATE_LAST_UPDT": "",
"LINES": {
"LINE_NUMBER": "",
"PART_ID": "",
"PO_DESC": "",
"PO_UM": "",
"DWG_REV": "",
"ECN": "",
"STORES_CODE": "",
"VENDOR_PART_ID": "",
"QC_FLAG": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"JOB_ID": "",
"OPER_CODE": "",
"REQ_DEL_DATE": "",
"DELIVERY_DATE": "",
"REV_DEL_DATE": "",
"ORDER_QTY": "",
"REV_ORDER_QTY": "",
"PO_UNIT_PRICE": "",
"ITEM_DISC_PCT": "",
"TAX_CODE": "",
"VAT_CODE": "",
"AMOUNT": "",
"LINE_TAX_AMT": "",
"LINE_TAX_2": "",
"LINE_TAX_3": "",
"LINE_TAX_4": "",
"LINE_TAX_5": "",
"LINE_TAX_6": "",
"LINE_TAX_7": "",
"LINE_TAX_8": "",
"LINE_TAX_9": "",
"LINE_TAX_10": "",
"LINE_VAT": "",
"LINE_ORDER_DISC": "",
"PARTIAL_SHIP": "",
"REQUESTOR": "",
"PO_LINE_HOLD": "",
"PO_LINE_STATUS": "",
"STOCK_BUY_FLAG": "",
"DM_PRINT_DATE": "",
"DATE_LAST_ACT": "",
"RECEIVED_QTY": "",
"RETURN_QTY": "",
"ACCEPTED_QTY": "",
"SCRAPPED_QTY": "",
"QC_BAL_QTY": "",
"BALANCE_DUE": "",
"KIT_UPDATE": "",
"BLANKET_LINE": "",
"CHANGE_NO": "",
"CHANGE_DATE": "",
"CHANGE_CODE": "",
"EARLY_RECEIPT": "",
"LC_UNIT_PRICE": "",
"LC_AMOUNT": "",
"PART_UM": "",
"INV_ORDER_QTY": "",
"INV_REVISED_QTY": "",
"INV_RECV_QTY": "",
"INV_RETN_QTY": "",
"INV_ACPT_QTY": "",
"INV_SCRP_QTY": "",
"INV_QC_QTY": "",
"INV_BAL_DUE": "",
"BUY_CONV": "",
"BUY_DEC": "",
"PRICE_CODE": "",
"POFOD_USER_1": "",
"POFOD_USER_2": "",
"POFOD_USER_3": "",
"POFOD_USER_4": "",
"POFOD_USER_5": "",
"POFOD_USER_6": "",
"POFOD_USER_7": "",
"POFOD_USER_8": "",
"POFOD_USER_9": "",
"POFOD_USER_10": "",
"POFOD_USER_11": "",
"POFOD_USER_12": "",
"POFOD_USER_13": "",
"POFOD_USER_14": "",
"POFOD_USER_15": "",
"POFOD_USER_16": "",
"MRB_BAL_QTY": "",
"INV_MRB_QTY": "",
"SO_CREATED": "",
"SO_ID": "",
"SO_LINE_NO": "",
"REQUISITION_NO": "",
"REQ_LINE_NO": "",
"BOX_NUMBER": "",
"SHIP_VIA": "",
"SHIP_TRAC_NO": "",
"SHIPMENT_NO": "",
"BILL_OF_LADING": "",
"PO_LINE_CAT": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": ""
},
"AUTH_TOKEN": ""
}QBE Notation
This query uses Expandable Query By Example (QBE) Notation. QBE Notation allows for conditional query criteria.
Not Equal To:
Greater Than:
Greater Than Or Equal To:
Less Than:
Less Than Or Equal To:
Between:
In:
Wildcard (any length):
Wildcard (single character):
Not Equal To:
"SO_STATUS": "<>X"Greater Than:
"ON_HAND_QTY": ">0"Greater Than Or Equal To:
"EFFECTIVE_DATE": ">=2016-01-01"Less Than:
"AMOUNT": "<100"Less Than Or Equal To:
"DATE_APPROVED": "<=2019-05-30"Between:
"ORDER_QTY": "BETWEEN 10 AND 100"In:
"LOT_STATUS": "IN A,C"Wildcard (any length):
"PART_ID": "MOTOR%"Wildcard (single character):
"SERIAL_NUMBER": "GC0000406_"Success Response
Returned HTTP status indicates success:
200/OK
Returned JSON contains the Purchase Orders which were found by the query:
200/OK
Returned JSON contains the Purchase Orders which were found by the query:
[
{
"PO_ID": "",
"PO_TYPE": "",
"VENDOR_ID": "",
"VENDOR_NAME": "",
"ORDER_DATE": "",
"ORDER_CLASS": "",
"CHANGE_NO": "",
"CHANGE_DATE": "",
"CHANGE_CODE": "",
"DROP_SHIP_ID": "",
"SHIP_NAME": "",
"BILL_TO_ID": "",
"BILL_NAME": "",
"CONFIRMED_TO": "",
"REFERENCE": "",
"BLANKET_ID": "",
"TERMS_CODE": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"TAX_CODE": "",
"BUYER_ID": "",
"ORDER_DISC_PCT": "",
"CURR_CODE": "",
"CURR_RATE": "",
"PO_HOLD": "",
"PO_STATUS": "",
"DATE_LAST_PRINT": "",
"POFOM_USER_1": "",
"POFOM_USER_2": "",
"POFOM_USER_3": "",
"POFOM_USER_4": "",
"POFOM_USER_5": "",
"POFOM_USER_6": "",
"POFOM_USER_7": "",
"POFOM_USER_8": "",
"POFOM_USER_9": "",
"POFOM_USER_10": "",
"POFOM_USER_11": "",
"POFOM_USER_12": "",
"POFOM_USER_13": "",
"POFOM_USER_14": "",
"POFOM_USER_15": "",
"POFOM_USER_16": "",
"POFOM_USER_17": "",
"POFOM_USER_18": "",
"POFOM_USER_19": "",
"POFOM_USER_20": "",
"POFOM_USER_21": "",
"POFOM_USER_22": "",
"POFOM_USER_23": "",
"POFOM_USER_24": "",
"POFOM_USER_25": "",
"POFOM_USER_26": "",
"POFOM_USER_27": "",
"POFOM_USER_28": "",
"POFOM_USER_29": "",
"POFOM_USER_30": "",
"POFOM_USER_31": "",
"POFOM_USER_32": "",
"POFOM_USER_33": "",
"POFOM_USER_34": "",
"POFOM_USER_35": "",
"POFOM_USER_36": "",
"POFOM_USER_37": "",
"POFOM_USER_38": "",
"POFOM_USER_39": "",
"POFOM_USER_40": "",
"PO_LIMIT_AMT": "",
"PO_EXPIRATION": "",
"LAST_REL_ID": "",
"TOTAL_RELEASES": "",
"TOTAL_REL_AMT": "",
"DATE_LAST_EDI": "",
"ORIG_PO_AMT": "",
"REVISED_PO_AMT": "",
"PAYMENTS_MADE": "",
"E_MAIL": "",
"E_MAIL_DATE": "",
"CHANGE_NO_EDI": "",
"PO_EXPIRE_DATE": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"NUMBER_BOXES": "",
"TOTAL_BOXES": "",
"PO_ORDER_CAT": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": "",
"ORDER_SUBTOTAL": "",
"ORDER_DISC_AMT": "",
"ORDER_TAX_AMT": "",
"ORDER_TAX_2": "",
"ORDER_TAX_3": "",
"ORDER_TAX_4": "",
"ORDER_TAX_5": "",
"ORDER_TAX_6": "",
"ORDER_TAX_7": "",
"ORDER_TAX_8": "",
"ORDER_TAX_9": "",
"ORDER_TAX_10": "",
"ORDER_VAT": "",
"ORDER_TOTAL": "",
"NOTES": "",
"ATTACHMENTS": "",
"LINES": [
{
"LINE_NUMBER": "",
"PART_ID": "",
"PO_DESC": "",
"PO_UM": "",
"DWG_REV": "",
"ECN": "",
"STORES_CODE": "",
"VENDOR_PART_ID": "",
"QC_FLAG": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"JOB_ID": "",
"OPER_CODE": "",
"REQ_DEL_DATE": "",
"DELIVERY_DATE": "",
"REV_DEL_DATE": "",
"ORDER_QTY": "",
"REV_ORDER_QTY": "",
"PO_UNIT_PRICE": "",
"ITEM_DISC_PCT": "",
"TAX_CODE": "",
"VAT_CODE": "",
"AMOUNT": "",
"LINE_TAX_AMT": "",
"LINE_TAX_2": "",
"LINE_TAX_3": "",
"LINE_TAX_4": "",
"LINE_TAX_5": "",
"LINE_TAX_6": "",
"LINE_TAX_7": "",
"LINE_TAX_8": "",
"LINE_TAX_9": "",
"LINE_TAX_10": "",
"LINE_VAT": "",
"LINE_ORDER_DISC": "",
"PARTIAL_SHIP": "",
"REQUESTOR": "",
"PO_LINE_HOLD": "",
"PO_LINE_STATUS": "",
"STOCK_BUY_FLAG": "",
"DM_PRINT_DATE": "",
"DATE_LAST_ACT": "",
"RECEIVED_QTY": "",
"RETURN_QTY": "",
"ACCEPTED_QTY": "",
"SCRAPPED_QTY": "",
"QC_BAL_QTY": "",
"BALANCE_DUE": "",
"KIT_UPDATE": "",
"BLANKET_LINE": "",
"CHANGE_NO": "",
"CHANGE_DATE": "",
"CHANGE_CODE": "",
"EARLY_RECEIPT": "",
"LC_UNIT_PRICE": "",
"LC_AMOUNT": "",
"PART_UM": "",
"INV_ORDER_QTY": "",
"INV_REVISED_QTY": "",
"INV_RECV_QTY": "",
"INV_RETN_QTY": "",
"INV_ACPT_QTY": "",
"INV_SCRP_QTY": "",
"INV_QC_QTY": "",
"INV_BAL_DUE": "",
"BUY_CONV": "",
"BUY_DEC": "",
"PRICE_CODE": "",
"POFOD_USER_1": "",
"POFOD_USER_2": "",
"POFOD_USER_3": "",
"POFOD_USER_4": "",
"POFOD_USER_5": "",
"POFOD_USER_6": "",
"POFOD_USER_7": "",
"POFOD_USER_8": "",
"POFOD_USER_9": "",
"POFOD_USER_10": "",
"POFOD_USER_11": "",
"POFOD_USER_12": "",
"POFOD_USER_13": "",
"POFOD_USER_14": "",
"POFOD_USER_15": "",
"POFOD_USER_16": "",
"MRB_BAL_QTY": "",
"INV_MRB_QTY": "",
"SO_CREATED": "",
"SO_ID": "",
"SO_LINE_NO": "",
"REQUISITION_NO": "",
"REQ_LINE_NO": "",
"BOX_NUMBER": "",
"SHIP_VIA": "",
"SHIP_TRAC_NO": "",
"SHIPMENT_NO": "",
"BILL_OF_LADING": "",
"PO_LINE_CAT": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": ""
}
],
"COMMENTS": [
{
"PO_LINE_NO": "",
"PRINT_PO": "",
"COMMENT_TEXT": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": ""
}
],
"EXTENDED_USER": [
{
"LINE_NUMBER": "",
"POFDXU_USER_1": "",
"POFDXU_USER_2": "",
"POFDXU_USER_3": "",
"POFDXU_USER_4": "",
"POFDXU_USER_5": "",
"POFDXU_USER_6": "",
"POFDXU_USER_7": "",
"POFDXU_USER_8": "",
"POFDXU_USER_9": "",
"POFDXU_USER_10": "",
"POFDXU_USER_11": "",
"POFDXU_USER_12": "",
"POFDXU_USER_13": "",
"POFDXU_USER_14": "",
"POFDXU_USER_15": "",
"POFDXU_USER_16": "",
"POFDXU_USER_17": "",
"POFDXU_USER_18": "",
"POFDXU_USER_19": "",
"POFDXU_USER_20": "",
"POFDXU_USER_21": "",
"POFDXU_USER_22": "",
"POFDXU_USER_23": "",
"POFDXU_USER_24": "",
"POFDXU_USER_25": "",
"POFDXU_USER_26": "",
"POFDXU_USER_27": "",
"POFDXU_USER_28": "",
"POFDXU_USER_29": "",
"POFDXU_USER_30": "",
"POFDXU_USER_31": "",
"POFDXU_USER_32": "",
"POFDXU_USER_33": "",
"POFDXU_USER_34": "",
"POFDXU_USER_35": "",
"POFDXU_USER_36": "",
"POFDXU_USER_37": "",
"POFDXU_USER_38": "",
"POFDXU_USER_39": "",
"POFDXU_USER_40": "",
"POFDXU_USER_41": "",
"POFDXU_USER_42": "",
"POFDXU_USER_43": "",
"POFDXU_USER_44": "",
"POFDXU_USER_45": "",
"POFDXU_USER_46": "",
"POFDXU_USER_47": "",
"POFDXU_USER_48": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": ""
}
]
}
]Failure Response
Returned HTTP status indicates failure:
400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed Purchase Order query:
400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed Purchase Order query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}