Additional REST APIs to Perform Sort and Receive
In 24C, the Sort and Receive transaction has been enhanced with the following new APIs:
VALIDATE RECEIVING STATION
To validate if location type is a Receiving Station or not, a new API has been created.
POST ..lgfapi/v10/sort_receive/validate_receiving_station
Example Response
POST ..lgfapi/v10/sort_receive/validate_receiving_station
{
"parameters": {
"receiving station" : location_barcode
}
VALIDATE SHIPMENT
To allow users to validate shipment number during the sort and receive transaction, the following new API has been added.
POST ..lgfapi/v10/sort_receive/validate_shipment
Example Response
POST ..lgfapi/v10/sort_receive/validate_shipment
{
"shipment number" : "12345"
}
NOTE: On successfully response, the validate_shipment API returns Shipment Number, ASN type, Dock Number, and Trailer Number.
VALIDATE LOAD RECEIVING FIELDS
To allow users to validate a load as required for the Sort and Receive transaction.
POST ..lgfapi/v10/sort_recieve/validate_load
Example Response
POST ..lgfapi/v10/sort_recieve/validate_load
{
"load_nbr" : "12345"
}
NOTE: On successfully response, the validate_load API returns Dock Number, Trailer Number, Load Number.
TO END TOTE or LPN
To allow users to end a tote during the Sort and Receive transaction following API has been introduced.
POST sort_receive/end_lpn
Example Request Body
{{{}}
"container_nbr": {}"LPN0001",
"location_barcode": {}"LOCN0001",
"lock_code_list": [
"LOCK0001",
"LOCK0002"
]
}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
container_nbr |
String | Y |
Container number |
|
location_barcode |
String | Y |
Location barcode for receiving station |
|
lock_code_list |
Array | N |
Array of lock codes |
GET DIRECTED TOTE
To allow users to get directed tote for Sorting and Receiving, the following API has been introduced.
POST sort_receive/get_directed_tote
Example Request Body
{{{}}
"location_barcode": {}"LOCN0001",
"attributes_map": {"batch_nbr" : foo,
"attr_a": bar,
"attr_d": spam
},
"ib_shipment_dtl_id": {}255,
"qty": {}10
}
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
|
location_barcode |
String |
Y |
Location barcode |
|
|
attributes_map |
Object |
N |
Attribute values (including batch & expiry) |
|
|
ib_shipment_dtl_id |
Integer |
Y |
IbShipment detail ID |
|
|
qty |
Integer or Number? |
N | 1 |
VALIDATE EXPIRY DATE
To allow users validate the expiry date for Sorting and Receiving following API has been introduced.
POST entity/ib_shipment_dtl/validate_expiry_date
Example Request Body
{
"container_nbr": {}"LPN0001"
} options:{
"shipment_nbr": {}"ASN0001",
"expiry_date": {}"2024-04-19"
}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
container_nbr |
String | Y |
Container number |
|
shipment_nbr |
String |
N |
Shipment number |
|
load_nbr |
String |
N |
Load number |
|
expiry_date |
Date |
C |
Expiry date |
|
manufacture_date |
Date |
C |
Manufacture date |
|
ib_shipment_dtl_id |
Integer |
N |
Inbound shipment detail ID |
You now have the option to perform additional sort and receive tasks with several new APIs.
Steps to Enable
Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.