Expandable Web API - Serial Number, Query

Serial Number, Query

Queries existing Serial Numbers using the provided criteria and returns a list of found Serial Numbers.

URL

/api/serial-number-query

Request Method

POST

Expandable Program

Serial Number Editor (SOESN)

Required Fields

(at least one field to be used as query criteria)
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

{
  "PART_ID": "MOTOR003",
  "STORES_CODE": "MS",
  "STOCK_LOCATION": "ISLE 9/SHELF 3",
  "SERIAL_NUMBER": "BETWEEN GC00004050 AND GC00004060",
  "AUTH_TOKEN": ""
}

Full Request JSON

{
  "PART_ID": "",
  "SERIAL_NUMBER": "",
  "LOT_ID": "",
  "SHIP_TO_CUST": "",
  "SN_STATUS": "",
  "STORES_CODE": "",
  "STOCK_LOCATION": "",
  "FROM_STORES": "",
  "FROM_LOCATION": "",
  "SO_ID": "",
  "SO_LINE_NO": "",
  "SHIPMENT_NO": "",
  "SOLD_TO_CUST": "",
  "BILL_TO_CUST": "",
  "SHIPPED_DATE": "",
  "SHIP_TYPE": "",
  "RETURNED_DATE": "",
  "DATE_SCRAPPED": "",
  "DATE_CONSIGNED": "",
  "RA_REASON": "",
  "DWG_REV": "",
  "ECN": "",
  "ON_WARRANTY": "",
  "OFF_WARRANTY": "",
  "SERV_CONTRACT": "",
  "CONTACT": "",
  "LOCATION": "",
  "REFERENCE": "",
  "LAST_SERVICE": "",
  "NEXT_SERVICE": "",
  "ORDER_ID": "",
  "LINE_NUMBER": "",
  "ORDER_REFERENCE": "",
  "BATCH_NUMBER": "",
  "PROGRAM_ID": "",
  "ORIG_SO_ID": "",
  "ORIG_SHIP_TO": "",
  "ORIG_SHIP_DATE": "",
  "LAST_INVOICE": "",
  "SOFSN_USER_1": "",
  "SOFSN_USER_2": "",
  "SOFSN_USER_3": "",
  "SOFSN_USER_4": "",
  "SOFSN_USER_5": "",
  "SOFSN_USER_6": "",
  "SOFSN_USER_7": "",
  "SOFSN_USER_8": "",
  "SOFSN_USER_9": "",
  "SOFSN_USER_10": "",
  "SOFSN_USER_11": "",
  "SOFSN_USER_12": "",
  "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:

"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 Serial Numbers which were found by the query:

[
  {
    "PART_ID": "",
    "SERIAL_NUMBER": "",
    "LOT_ID": "",
    "SHIP_TO_CUST": "",
    "SN_STATUS": "",
    "STORES_CODE": "",
    "STOCK_LOCATION": "",
    "FROM_STORES": "",
    "FROM_LOCATION": "",
    "SO_ID": "",
    "SO_LINE_NO": "",
    "SHIPMENT_NO": "",
    "SOLD_TO_CUST": "",
    "BILL_TO_CUST": "",
    "SHIPPED_DATE": "",
    "SHIP_TYPE": "",
    "RETURNED_DATE": "",
    "DATE_SCRAPPED": "",
    "DATE_CONSIGNED": "",
    "RA_REASON": "",
    "DWG_REV": "",
    "ECN": "",
    "ON_WARRANTY": "",
    "OFF_WARRANTY": "",
    "SERV_CONTRACT": "",
    "CONTACT": "",
    "LOCATION": "",
    "REFERENCE": "",
    "LAST_SERVICE": "",
    "NEXT_SERVICE": "",
    "ORDER_ID": "",
    "LINE_NUMBER": "",
    "ORDER_REFERENCE": "",
    "BATCH_NUMBER": "",
    "PROGRAM_ID": "",
    "ORIG_SO_ID": "",
    "ORIG_SHIP_TO": "",
    "ORIG_SHIP_DATE": "",
    "LAST_INVOICE": "",
    "SOFSN_USER_1": "",
    "SOFSN_USER_2": "",
    "SOFSN_USER_3": "",
    "SOFSN_USER_4": "",
    "SOFSN_USER_5": "",
    "SOFSN_USER_6": "",
    "SOFSN_USER_7": "",
    "SOFSN_USER_8": "",
    "SOFSN_USER_9": "",
    "SOFSN_USER_10": "",
    "SOFSN_USER_11": "",
    "SOFSN_USER_12": "",
    "CREATED_BY": "",
    "DATE_CREATED": "",
    "MODIFIED_BY": "",
    "DATE_MODIFIED": "",
    "OPERATOR_ID": "",
    "DATE_LAST_UPDT": "",
    "TIME_LAST_UPDT": "",
    "NOTES": "",
    "ATTACHMENTS": ""
  }
]

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 Serial Number query:

{
  "MESSAGE": "",
  "MESSAGE_CODE": ""
}

Try the API