api/ShipmentsEntry/Query (POST)

Queries existing Shipments using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Shipments.

Request Information

Parameters

NameDescriptionAdditional information
RequestData 
This is a JSON object containing Shipment query data.

Query Single Shipment Using Key Fields Example:
{
  "RECNUM": "4001",
  "SO_ID": "123456",
  "SO_LINE_NO": "1.00",
  "ACTION_DATE": "7/10/2015"
}
Returns 1 Shipment if successful.
This is like 'Find' in Expandable.

Query Multiple Shipments Using Other Fields Example:
{
  "PART_ID": "MOTOR003",
  "SHIP_TYPE": "S"
}
Returns 1 or more Shipments if successful.
This is like 'QBE' in Expandable.

Query Multiple Shipments Using QBE Conditional Notation Example:
{
  "INV_QUANTITY": ""> 99",
  "SHIP_TYPE": "IN 'O','S'"
}
Returns 1 or more Shipments if successful.
This is like 'QBE' in Expandable.

Accepted Shipments Entry Fields:
ACCOUNT, ACTION_DATE, ACTION_TYPE, ACTUAL_COST, 
AMOUNT, AR_BC_RATE, AR_CURR_RATE, BATCH_NUMBER, 
BILL_OF_LADING, BOX_NUMBER, COMPANY_ID, COST_AMT, 
CREATED_BY, DATE_CREATED, DATE_LAST_EDI, DATE_LAST_UPDT, 
DATE_MODIFIED, DEPARTMENT, DWG_REV, ECN, 
GL_MONTH, GL_YEAR, INV_LINE_NO, INV_QUANTITY, 
INVOICE_DATE, INVOICE_NUMBER, JOB_ID, LC_AMOUNT, 
LOCK_STATUS, LOT_ID, MODIFIED_BY, NUMBER_CARTONS, 
OPER_CODE, OPERATOR_ID, ORDER_DIFF, PACK_LIST_FLAG, 
PACK_SHIP_ID, PACK_SLIP_DATE, PART_ID, PART_UM, 
PROGRAM_ID, QUANTITY, REASON_CODE, RECNUM, 
REFERENCE, REPORT_FLAG, REQ_SHIP_DATE, REV_SHIP_DATE, 
SALE_CONV, SALE_DEC, SCH_SHIP_DATE, SHIP_TYPE, 
SHIP_VIA, SHIPMENT_NO, SO_BC_RATE, SO_CURR_RATE, 
SO_ID, SO_LINE_NO, SO_UM, SOFST_USER_1, 
SOFST_USER_2, STOCK_LOCATION, STORES_CODE, TIME_LAST_UPDT, 
TO_LOCATION, TO_STORES, TOTAL_BOXES, WEIGHT

Define this parameter in the request body.

Response Information

Success:
200/OK
Body contains JSON array with found Shipments.

Error:
400/Request JSON is invalid.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.

Returned Shipments Entry Fields:
ACCOUNT, ACTION_DATE, ACTION_TYPE, ACTUAL_COST, AMOUNT, AR_BC_RATE, AR_CURR_RATE, BATCH_NUMBER, BILL_OF_LADING, BOX_NUMBER, COMPANY_ID, COST_AMT, CREATED_BY, DATE_CREATED, DATE_LAST_EDI, DATE_LAST_UPDT, DATE_MODIFIED, DEPARTMENT, DWG_REV, ECN, GL_MONTH, GL_YEAR, INV_LINE_NO, INV_QUANTITY, INVOICE_DATE, INVOICE_NUMBER, JOB_ID, LC_AMOUNT, LOCK_STATUS, LOT_ID, MODIFIED_BY, NUMBER_CARTONS, OPER_CODE, OPERATOR_ID, ORDER_DIFF, PACK_LIST_FLAG, PACK_SHIP_ID, PACK_SLIP_DATE, PART_ID, PART_UM, PROGRAM_ID, QUANTITY, REASON_CODE, RECNUM, REFERENCE, REPORT_FLAG, REQ_SHIP_DATE, REV_SHIP_DATE, SALE_CONV, SALE_DEC, SCH_SHIP_DATE, SHIP_TYPE, SHIP_VIA, SHIPMENT_NO, SO_BC_RATE, SO_CURR_RATE, SO_ID, SO_LINE_NO, SO_UM, SOFST_USER_1, SOFST_USER_2, STOCK_LOCATION, STORES_CODE, TIME_LAST_UPDT, TO_LOCATION, TO_STORES, TOTAL_BOXES, WEIGHT