Modify Item Quantity

The IBLPN modify_item_qty API allows the caller to adjust item inventory in a “Received” or “Located” IBLPN. You can only update a single IBLPN and item per request.

Regardless of the method used to identify the IBLPN, the following input is valid:

Category Name Type Required Description
options item_barcode String C Item identifier.
options item_alternate_code String C Item identifier.
options adjustment_qty Numeric Y Non-zero adjustment quantity.
options batch_nbr String N Batch tied to target inventory.
options expiry_date Date N Expiration date tied to target inventory.
options invn_attr_X String N Attributes A-O tied to the inventory.
options reason_code String Y Recorded on inventory history.
options transaction_ref_nbr String N Recorded on inventory history.
Parameters actual_qty Numeric Y Actual quantity of the LPN
options serial_nbr_list String N Serial Number list
  • Only one of `item_barcode` or `item_alternate_code` is allowed.
  • IBLPN inventory matching is restrictive and does not support wildcard searches:
    • If no `batch_nbr` is provided, only match IBLPN inventory without a batch.
    • If no `expriy_date` is provided, only match IBLPN inventory without expiration.
    • If no `invn_attr_X` value is provided for A-O, it will be treated as blank.
    • The user must send either adjusted quantity or actual quantity.

IBLPN Lookup by ID

POST .../entity/iblpn/{id}/modify_item_qty/

Caller knows the unique `id` value of the IBLPN, which is added to the request URL. No additional `parameters` data is required from the request body.

IBLPN Lookup by Filters

POST .../entity/iblpn/modify_item_qty/
Category Name Type Required Description
parameters container_nbr String Y IBLPN to be adjusted.
parameters facility_id Integer N IBLPN’s facility.
parameters company_id Integer N IBLPN’s company.
  • Only a single IBLPN may be moved per request.
    • The `__in` lookup is not supported for `container_nbr`.
  • `facility_id` and `company_id` both additionally support string lookup by `code` using the double-underscore notation:
    • facility_id__code
    • company_id_code
Example Request Body:
{
    "options": {
       "item_barcode": "ITEM1234",
       "actual_qty": 13,
       "batch_nbr": "BATCH1234",
       "expiry_date": "2020-01-02",
       "invn_attr_a": "A",
       "reason_code": "C",
       "transaction_ref_nbr": "TX123457890",
       "serial_nbr_list": ["SN001", "SN002",...,"SN0013"]
    }
}