Shipment Transaction, Query
Queries existing Shipment Transactions using the provided criteria and returns a list of found Shipment Transactions.
URL
/api/shipment-transaction-query
Request Method
POST
Expandable Program
Shipment Transactions (SOISTG)
Required Fields
(at least one field to be used as query criteria)
AUTH_TOKEN
AUTH_TOKEN
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
{
"SO_ID": "100399",
"ACTION_TYPE": "<>FR",
"AUTH_TOKEN": ""
}Full Request JSON
{
"SO_ID": "",
"SO_LINE_NO": "",
"SHIPMENT_NO": "",
"PART_ID": "",
"ACTION_DATE": "",
"QUANTITY": "",
"SHIP_VIA": "",
"BILL_OF_LADING": "",
"ACTION_TYPE": "",
"BATCH_NUMBER": "",
"GL_YEAR": "",
"GL_MONTH": "",
"REFERENCE": "",
"LOT_ID": "",
"STORES_CODE": "",
"STOCK_LOCATION": "",
"SO_UM": "",
"JOB_ID": "",
"OPER_CODE": "",
"REASON_CODE": "",
"INVOICE_NUMBER": "",
"INV_LINE_NO": "",
"INVOICE_DATE": "",
"PART_UM": "",
"INV_QUANTITY": "",
"CUSTOMER_ID": "",
"SO_TYPE": "",
"SO_STATUS": "",
"PART_DESC": "",
"CUSTOMER_NAME": "",
"DWG_REV": "",
"ECN": "",
"SHIP_TYPE": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"COST_AMT": "",
"AMOUNT": "",
"LC_AMOUNT": "",
"ORDER_DIFF": "",
"SALE_CONV": "",
"SALE_DEC": "",
"PROGRAM_ID": "",
"REPORT_FLAG": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"ACTUAL_COST": "",
"TO_STORES": "",
"TO_LOCATION": "",
"SO_CURR_RATE": "",
"AR_CURR_RATE": "",
"SO_BC_RATE": "",
"AR_BC_RATE": "",
"PACK_LIST_FLAG": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"REQ_SHIP_DATE": "",
"SCH_SHIP_DATE": "",
"REV_SHIP_DATE": "",
"SOFST_USER_1": "",
"SOFST_USER_2": "",
"SHIP_TO_CUST": "",
"ORDER_DATE": "",
"ORDER_CLASS": "",
"CHANGE_NO": "",
"CHANGE_DATE": "",
"CHANGE_CODE": "",
"BILL_TO_CUST": "",
"CUST_PO_ID": "",
"CONFIRMED_TO": "",
"SALESMAN_ID": "",
"SALES_REGION": "",
"TERMS_CODE": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"TAX_CODE": "",
"ORDER_DISC_PCT": "",
"CURR_CODE": "",
"CURR_RATE": "",
"ORDER_TAKER": "",
"ATTENTION": "",
"SO_HOLD": "",
"PAYMENT_TYPE": "",
"CARD_TYPE": "",
"BANK_CARD_ID": "",
"EXPIRATION": "",
"AUTH_CODE": "",
"DATE_LAST_PRINT": "",
"DATE_APPROVED": "",
"DATE_LAST_SHIP": "",
"SHIP_NOTE_1": "",
"SHIP_NOTE_2": "",
"DELAY_INVOICE": "",
"DELAY_DAYS": "",
"COMPLETE_ONLY": "",
"PART_TYPE": "",
"SEARCH_NAME": "",
"DWG_SIZE": "",
"ECN_EFF_DATE": "",
"PENDING_ECN": "",
"PLANNER_ID": "",
"BUYER_ID": "",
"PREF_VENDOR": "",
"AUTO_PO_CREATE": "",
"ABC_CODE": "",
"COMM_CODE": "",
"ICFPM_USER_1": "",
"ICFPM_USER_2": "",
"ICFPM_USER_3": "",
"ICFPM_USER_4": "",
"ICFPM_USER_5": "",
"ICFPM_USER_6": "",
"ICFPM_USER_7": "",
"ICFPM_USER_8": "",
"YIELD_FACTOR": "",
"DEF_STORES_CODE": "",
"ORDER_QTY": "",
"MAX_ORDER_QTY": "",
"VENDR_LEAD_TIME": "",
"RECEIVING_LT": "",
"KIT_LT": "",
"MFG_LT": "",
"SHIP_LT": "",
"PLAN_LEAD_TIME": "",
"CUM_LT": "",
"FORECAST_QTY": "",
"SO_ORDER_QTY": "",
"MIN_SALES_QTY": "",
"LOT_CONTROL": "",
"SHELF_LIFE": "",
"SN_REQD": "",
"VOLUME": "",
"STOCK_DEC": "",
"BUY_UM": "",
"BUY_CONV": "",
"BUY_DEC": "",
"SALE_UM": "",
"SUBST_PART": "",
"PRODUCT_LINE": "",
"MRP_FLAG": "",
"MPS_CODE": "",
"CATG_CODE": "",
"PLAN_HORIZON": "",
"DAYS_SUPPLY": "",
"COMMENT_ID": "",
"PART_STATUS": "",
"PART_CLASS": "",
"DATE_CREATED": "",
"ORIG_REL_DATE": "",
"DATE_ACTIVE": "",
"DATE_OBSOLETE": "",
"TAXABLE": "",
"VAT_CODE": "",
"STD_OH_PCT_BUY": "",
"STD_OH_PCT_OUT": "",
"STD_WORK_1": "",
"STD_1_HRS": "",
"STD_WORK_2": "",
"STD_2_HRS": "",
"STD_WORK_3": "",
"STD_3_HRS": "",
"STD_LAB_HRS_ADD": "",
"STD_LAB_HRS_CUM": "",
"STD_LAB_CST_ADD": "",
"STD_LAB_CST_CUM": "",
"STD_MTL_CST_ADD": "",
"STD_MTL_CST_CUM": "",
"STD_OUT_CST_ADD": "",
"STD_OUT_CST_CUM": "",
"STD_OTH_CST_ADD": "",
"STD_OTH_CST_CUM": "",
"STD_OHD_CST_ADD": "",
"STD_OHD_CST_CUM": "",
"STD_UNIT_COST": "",
"BASE_CURR": "",
"BC_RATE": "",
"BC_STD_COST": "",
"QTY_PER_CARTON": "",
"UPC_CODE": "",
"ITF_CODE": "",
"FRT_CLASS": "",
"WARRANTY_DAYS": "",
"SALES_MARKET": "",
"ORIG_COUNTRY": "",
"DATE_INACTIVE": "",
"PART_HOLD_CODE": "",
"SLX_PART": "",
"ICFPM_USER_9": "",
"ICFPM_USER_10": "",
"ICFPM_USER_11": "",
"ICFPM_USER_12": "",
"ICFPM_USER_13": "",
"ICFPM_USER_14": "",
"ICFPM_USER_15": "",
"ICFPM_USER_16": "",
"SN_REQD_INV": "",
"AL_PART_DESC": "",
"CATALOG_ID": "",
"CATALOG_DESC": "",
"AL_CUST_NAME": "",
"GEO": "",
"MA_GEO": "",
"CHANNEL": "",
"ADDRESS_1": "",
"ADDRESS_2": "",
"ADDRESS_3": "",
"CITY": "",
"STATE": "",
"ZIP_CODE": "",
"COUNTRY": "",
"SO_CONTACT": "",
"SO_PHONE_NO": "",
"FAX_NO": "",
"PRICE_CODE": "",
"SIC_CODE": "",
"FIN_CHG_FLAG": "",
"AR_FIN_CHG_PCT": "",
"AR_MIN_FIN_CHG": "",
"RESALE_ID": "",
"RESALE_ID_2": "",
"CLASS_CODE": "",
"AR_CONTACT": "",
"AR_PHONE_NO": "",
"SALES_DEPT": "",
"SALES_ACCT": "",
"DUNS_RATING": "",
"DUNS_DATE": "",
"CREDIT_LIMIT": "",
"CREDIT_RATING": "",
"AUTO_SO_HOLD": "",
"BANK_CODE": "",
"CUSTOMER_TYPE": "",
"CUSTOMER_STATUS": "",
"DATE_LAST_SO": "",
"DATE_LAST_INV": "",
"DATE_LAST_CHECK": "",
"DATE_LAST_STMT": "",
"DATE_LIMIT_UPDT": "",
"DATE_HIGH_BAL": "",
"SALES_LAST_YR": "",
"SALES_YTD": "",
"DISCOUNTS_YTD": "",
"CURRENT_ORDERS": "",
"CURRENT_BALANCE": "",
"UNAPPLIED_AMT": "",
"LAST_PAY_DAYS": "",
"HIGH_BALANCE": "",
"LANGUAGE": "",
"LC_CURR_ORDERS": "",
"LC_CURRENT_BAL": "",
"LC_UNAPPLIED": "",
"PARTIAL_SHIP": "",
"EARLY_SHIP": "",
"CREDIT_MGR": "",
"AR_REMIT_TO": "",
"SOFCM_USER_1": "",
"SOFCM_USER_2": "",
"SOFCM_USER_3": "",
"SOFCM_USER_4": "",
"SOFCM_USER_5": "",
"SOFCM_USER_6": "",
"SOFCM_USER_7": "",
"SOFCM_USER_8": "",
"COMMENT_1": "",
"COMMENT_2": "",
"COMMENT_3": "",
"COMMENT_4": "",
"COMMENT_5": "",
"COMMENT_6": "",
"COMMENT_7": "",
"COMMENT_8": "",
"AUTO_AR_INVOICE": "",
"YTD_AMT_PAID": "",
"YTD_DAYS_PAID": "",
"YTD_LATE_PAID": "",
"AVG_PAY_DAYS": "",
"AVG_LATE_DAYS": "",
"PR_YR_PAY_DAYS": "",
"PR_YR_LATE_DAYS": "",
"FRT_BILL_TO": "",
"PRICE_CODE_2": "",
"PRICE_CODE_3": "",
"NAICS_CODE": "",
"CUST_MARKET": "",
"EXPIRE_DATE": "",
"LOT_STATUS": "",
"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 Shipment Transactions which were found by the query:
200/OK
Returned JSON contains the Shipment Transactions which were found by the query:
[
{
"SO_ID": "",
"SO_LINE_NO": "",
"SHIPMENT_NO": "",
"PART_ID": "",
"ACTION_DATE": "",
"QUANTITY": "",
"SHIP_VIA": "",
"BILL_OF_LADING": "",
"ACTION_TYPE": "",
"BATCH_NUMBER": "",
"GL_YEAR": "",
"GL_MONTH": "",
"REFERENCE": "",
"LOT_ID": "",
"STORES_CODE": "",
"STOCK_LOCATION": "",
"SO_UM": "",
"JOB_ID": "",
"OPER_CODE": "",
"REASON_CODE": "",
"INVOICE_NUMBER": "",
"INV_LINE_NO": "",
"INVOICE_DATE": "",
"PART_UM": "",
"INV_QUANTITY": "",
"CUSTOMER_ID": "",
"SO_TYPE": "",
"SO_STATUS": "",
"PART_DESC": "",
"CUSTOMER_NAME": "",
"DWG_REV": "",
"ECN": "",
"SHIP_TYPE": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"COST_AMT": "",
"AMOUNT": "",
"LC_AMOUNT": "",
"ORDER_DIFF": "",
"SALE_CONV": "",
"SALE_DEC": "",
"PROGRAM_ID": "",
"REPORT_FLAG": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"ACTUAL_COST": "",
"TO_STORES": "",
"TO_LOCATION": "",
"SO_CURR_RATE": "",
"AR_CURR_RATE": "",
"SO_BC_RATE": "",
"AR_BC_RATE": "",
"PACK_LIST_FLAG": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"REQ_SHIP_DATE": "",
"SCH_SHIP_DATE": "",
"REV_SHIP_DATE": "",
"SOFST_USER_1": "",
"SOFST_USER_2": "",
"SHIP_TO_CUST": "",
"ORDER_DATE": "",
"ORDER_CLASS": "",
"CHANGE_NO": "",
"CHANGE_DATE": "",
"CHANGE_CODE": "",
"BILL_TO_CUST": "",
"CUST_PO_ID": "",
"CONFIRMED_TO": "",
"SALESMAN_ID": "",
"SALES_REGION": "",
"TERMS_CODE": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"TAX_CODE": "",
"ORDER_DISC_PCT": "",
"CURR_CODE": "",
"CURR_RATE": "",
"ORDER_TAKER": "",
"ATTENTION": "",
"SO_HOLD": "",
"PAYMENT_TYPE": "",
"CARD_TYPE": "",
"BANK_CARD_ID": "",
"EXPIRATION": "",
"AUTH_CODE": "",
"DATE_LAST_PRINT": "",
"DATE_APPROVED": "",
"DATE_LAST_SHIP": "",
"SHIP_NOTE_1": "",
"SHIP_NOTE_2": "",
"DELAY_INVOICE": "",
"DELAY_DAYS": "",
"COMPLETE_ONLY": "",
"PART_TYPE": "",
"SEARCH_NAME": "",
"DWG_SIZE": "",
"ECN_EFF_DATE": "",
"PENDING_ECN": "",
"PLANNER_ID": "",
"BUYER_ID": "",
"PREF_VENDOR": "",
"AUTO_PO_CREATE": "",
"ABC_CODE": "",
"COMM_CODE": "",
"ICFPM_USER_1": "",
"ICFPM_USER_2": "",
"ICFPM_USER_3": "",
"ICFPM_USER_4": "",
"ICFPM_USER_5": "",
"ICFPM_USER_6": "",
"ICFPM_USER_7": "",
"ICFPM_USER_8": "",
"YIELD_FACTOR": "",
"DEF_STORES_CODE": "",
"ORDER_QTY": "",
"MAX_ORDER_QTY": "",
"VENDR_LEAD_TIME": "",
"RECEIVING_LT": "",
"KIT_LT": "",
"MFG_LT": "",
"SHIP_LT": "",
"PLAN_LEAD_TIME": "",
"CUM_LT": "",
"FORECAST_QTY": "",
"SO_ORDER_QTY": "",
"MIN_SALES_QTY": "",
"LOT_CONTROL": "",
"SHELF_LIFE": "",
"SN_REQD": "",
"VOLUME": "",
"STOCK_DEC": "",
"BUY_UM": "",
"BUY_CONV": "",
"BUY_DEC": "",
"SALE_UM": "",
"SUBST_PART": "",
"PRODUCT_LINE": "",
"MRP_FLAG": "",
"MPS_CODE": "",
"CATG_CODE": "",
"PLAN_HORIZON": "",
"DAYS_SUPPLY": "",
"COMMENT_ID": "",
"PART_STATUS": "",
"PART_CLASS": "",
"DATE_CREATED": "",
"ORIG_REL_DATE": "",
"DATE_ACTIVE": "",
"DATE_OBSOLETE": "",
"TAXABLE": "",
"VAT_CODE": "",
"STD_OH_PCT_BUY": "",
"STD_OH_PCT_OUT": "",
"STD_WORK_1": "",
"STD_1_HRS": "",
"STD_WORK_2": "",
"STD_2_HRS": "",
"STD_WORK_3": "",
"STD_3_HRS": "",
"STD_LAB_HRS_ADD": "",
"STD_LAB_HRS_CUM": "",
"STD_LAB_CST_ADD": "",
"STD_LAB_CST_CUM": "",
"STD_MTL_CST_ADD": "",
"STD_MTL_CST_CUM": "",
"STD_OUT_CST_ADD": "",
"STD_OUT_CST_CUM": "",
"STD_OTH_CST_ADD": "",
"STD_OTH_CST_CUM": "",
"STD_OHD_CST_ADD": "",
"STD_OHD_CST_CUM": "",
"STD_UNIT_COST": "",
"BASE_CURR": "",
"BC_RATE": "",
"BC_STD_COST": "",
"QTY_PER_CARTON": "",
"UPC_CODE": "",
"ITF_CODE": "",
"FRT_CLASS": "",
"WARRANTY_DAYS": "",
"SALES_MARKET": "",
"ORIG_COUNTRY": "",
"DATE_INACTIVE": "",
"PART_HOLD_CODE": "",
"SLX_PART": "",
"ICFPM_USER_9": "",
"ICFPM_USER_10": "",
"ICFPM_USER_11": "",
"ICFPM_USER_12": "",
"ICFPM_USER_13": "",
"ICFPM_USER_14": "",
"ICFPM_USER_15": "",
"ICFPM_USER_16": "",
"SN_REQD_INV": "",
"AL_PART_DESC": "",
"CATALOG_ID": "",
"CATALOG_DESC": "",
"AL_CUST_NAME": "",
"GEO": "",
"MA_GEO": "",
"CHANNEL": "",
"ADDRESS_1": "",
"ADDRESS_2": "",
"ADDRESS_3": "",
"CITY": "",
"STATE": "",
"ZIP_CODE": "",
"COUNTRY": "",
"SO_CONTACT": "",
"SO_PHONE_NO": "",
"FAX_NO": "",
"PRICE_CODE": "",
"SIC_CODE": "",
"FIN_CHG_FLAG": "",
"AR_FIN_CHG_PCT": "",
"AR_MIN_FIN_CHG": "",
"RESALE_ID": "",
"RESALE_ID_2": "",
"CLASS_CODE": "",
"AR_CONTACT": "",
"AR_PHONE_NO": "",
"SALES_DEPT": "",
"SALES_ACCT": "",
"DUNS_RATING": "",
"DUNS_DATE": "",
"CREDIT_LIMIT": "",
"CREDIT_RATING": "",
"AUTO_SO_HOLD": "",
"BANK_CODE": "",
"CUSTOMER_TYPE": "",
"CUSTOMER_STATUS": "",
"DATE_LAST_SO": "",
"DATE_LAST_INV": "",
"DATE_LAST_CHECK": "",
"DATE_LAST_STMT": "",
"DATE_LIMIT_UPDT": "",
"DATE_HIGH_BAL": "",
"SALES_LAST_YR": "",
"SALES_YTD": "",
"DISCOUNTS_YTD": "",
"CURRENT_ORDERS": "",
"CURRENT_BALANCE": "",
"UNAPPLIED_AMT": "",
"LAST_PAY_DAYS": "",
"HIGH_BALANCE": "",
"LANGUAGE": "",
"LC_CURR_ORDERS": "",
"LC_CURRENT_BAL": "",
"LC_UNAPPLIED": "",
"PARTIAL_SHIP": "",
"EARLY_SHIP": "",
"CREDIT_MGR": "",
"AR_REMIT_TO": "",
"SOFCM_USER_1": "",
"SOFCM_USER_2": "",
"SOFCM_USER_3": "",
"SOFCM_USER_4": "",
"SOFCM_USER_5": "",
"SOFCM_USER_6": "",
"SOFCM_USER_7": "",
"SOFCM_USER_8": "",
"COMMENT_1": "",
"COMMENT_2": "",
"COMMENT_3": "",
"COMMENT_4": "",
"COMMENT_5": "",
"COMMENT_6": "",
"COMMENT_7": "",
"COMMENT_8": "",
"AUTO_AR_INVOICE": "",
"YTD_AMT_PAID": "",
"YTD_DAYS_PAID": "",
"YTD_LATE_PAID": "",
"AVG_PAY_DAYS": "",
"AVG_LATE_DAYS": "",
"PR_YR_PAY_DAYS": "",
"PR_YR_LATE_DAYS": "",
"FRT_BILL_TO": "",
"PRICE_CODE_2": "",
"PRICE_CODE_3": "",
"NAICS_CODE": "",
"CUST_MARKET": "",
"EXPIRE_DATE": "",
"LOT_STATUS": ""
}
]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 Shipment Transaction 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 Shipment Transaction query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}