Additional REST APIs to Distribute LPNs
A set of APIs have added to allow user to perform distribution of LPNs via REST API request.
GET All DISTRIBUTIONS
The following API allows you to fetch all the current distributions available for the LPN.
Two options are available for you to filter the results. Item Barcode and Location Barcode.
If you use the Item Barcode, the system will filter only the results for that Item.
If you use location barcode, the system will sort the results with that location at the top, but it does not exclude other locations.
IBLPN Lookup by ID
POST /entity/iblpn/{id}/get_all_distributions/
Example Request Body
{{{}}
"options": {
"item_barcode": "ITM0001",
"location_barcode": "location0001"
}
}
IBLPN Lookup by Filter
POST /entity/iblpn/get_all_distributions/
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
container_nbr |
String | Y | IBLPN to distribute |
|
facility_id |
Integer | N | IBLPN's facility |
|
company_id |
Integer | N | IBLPN's company |
Example Request Body
{{{}}
"parameters": {
"container_nbr": "IBLPN00001",
},
"options": {
"item_barcode": "ITM0001",
"location_barcode": "location0001"
}
}
DISTRIBUTION RESPONSE STRUCTURE
| Name | Type | Description |
|---|---|---|
|
alloc_id |
Integer |
Allocation ID |
|
alloc_qty |
Number |
Allocation quantity |
|
alloc_uom |
String |
Allocation UOM |
|
alloc_uom_qty |
Number |
Allocation UOM quantity |
|
extra_included_allocs |
Array |
Advanced use case This is used when a single pick is made of multiple allocations |
|
from_invn_id |
Integer |
From inventory ID |
|
item_allow_decimal_qty |
Boolean |
Flag representing if we should allow decimals in item quantity |
|
item_alternate_code |
String |
Item alternate code |
|
item_barcode |
String |
Item barcode |
|
item_code |
String |
Item code |
|
item_display |
String |
Item display |
|
item_external_style |
String |
Item external style |
|
item_id |
Integer |
Item ID |
|
item_inner_pack_qty |
Number |
Item inner pack quantity |
|
item_std_case_qty |
Number |
Item standard case quantity |
|
location_barcode |
String |
Location barcode |
|
location_display |
String |
Location display |
|
location_id |
Integer |
Location ID |
|
location_type |
String |
Location type |
|
oblpn_nbr |
String |
OBLPN number |
|
order_nbrs |
Array |
Order numbers |
|
picked_qty |
Integer |
Picked quantity |
|
skipped_alloc_id_list |
Array |
Array of skipped allocation IDs |
|
style |
String |
Item style |
The response body for this API:
{
"distribution_info_list": [
{
"extra_included_allocs": [],
"alloc_id": 5672,
"skipped_alloc_id_list": [],
"from_invn_id": 18081,
"location_id": 52641,
"location_type": "C",
"location_display": "SR_11_06_03",
"location_barcode": "SR110603",
"item_id": 539566,
"item_barcode": "539556_",
"item_allow_decimal_qty": true,
"item_code": "539556",
"item_external_style": "",
"item_display": "itm",
"alloc_qty": 10.0,
"order_nbrs": [
"FAC_01"
],
"picked_qty": 0,
"oblpn_nbr": "",
"alloc_uom": "UNITS",
"item_alternate_code": "539556",
"style": "539556",
"alloc_uom_qty": 10.0,
"item_inner_pack_qty": 2.0,
"item_std_case_qty": 2.0
},
...
]
}
DISTRIBUTION REST API
This new Distribution REST API allows you to perform distribution on the selected LPN.
REST API Request by ID
POST /entity/iblpn/{id}/distribute/
Request body
| Name | Required | Type | Description |
|---|---|---|---|
|
Alloc_uom |
N |
String |
Allocation UOM: Units, Packs, Cases, Cases then Packs. |
|
Req_host_oblpn_nbr |
N |
String |
When true, requires order details to have a host OBLPN number. |
|
allow_residuals |
N |
Boolean |
Option to allow distribution with residuals. |
|
mhe_system_code |
N |
String |
Code for MHE system integration. |
Example request body
{{{}}
"options": {
"alloc_uom": "units",
"require_host_oblpn_nbr": false,
"allow_residuals": true,
"mhe_system_code": "system_code"
}
}
Rest API by Filter
POST /entity/iblpn/distribute/
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
container_nbr |
String |
Y |
IBLPN to distribute |
|
facility_id |
Integer |
N |
IBLPN's facility. |
|
company_id |
Integer |
N |
IBLPN's company |
NOTE: Only a single IBLPN may be distributed per request. The __in lookup is not supported for container_nbr.
Example Request Body
{{{}}
"parameters": {
"container_nbr": "IBLPN00001",
},
"options": {
"alloc_uom": "units",
"require_host_oblpn_nbr": false,
"allow_residuals": true,
"mhe_system_code": "system_code"
}
}
GET NEXT DISTRIBUTION
On performing distribution, user may want to anticipate the next pick information for the inventory. To get such required information, you can utilize the following rest API. Get Next Distribution is like Get All Distributions. Its input parameters are the same and the response has similar format as an individual record from Get All Distributions. Get Next Distribution is just giving the top result that you would get from Get All Distributions rather than a list.
POST /entity/iblpn/{id}/get_next_distribution/
Request body
| Name | Required | Type | Description |
|---|---|---|---|
|
item_barcode |
N |
String |
If populated, only includes allocations for this item |
|
Location_barcode |
N |
String |
If populated, gets next allocation starting from this location. If no matching is found for this barcode, it will be ignored. |
Example Request Body
{{{}}
"options": {
"item_barcode": "ITM0001",
"location_barcode": "location0001"
}
}
IBLPN Lookup by Filter
POST /entity/iblpn/get_next_distribution/
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
container_nbr |
String |
Y |
IBLPN to distribute. |
|
facility_id |
Integer |
N |
IBLPN's facility. |
|
company_id |
Integer |
N |
IBLPN's company. |
Example Request Body
{{{}}
"parameters": {
"container_nbr": "IBLPN00001",
},
"options": {
"item_barcode": "ITM0001",
"location_barcode": "location0001"
}
}
You now have the option to use this set of APIs to perform distribution of LPNs via REST API request.
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.