Item Quantity By Lots API

Overview

The WMS Item Quantity By Lots API is a Business Central API page designed to manage item quantities by lot. This API allows external systems to retrieve information about item quantities available in specific lots across locations.

API Details

  • Publisher: smart
  • API Group: wms
  • API Version: v2.0
  • Entity Name: itemQtyByLot
  • Entity Set Name: itemQtyByLots
  • Source Table: SMA Shipment Check Register
  • ODataKeyFields: Location Code, Item No., Lot No.

Fields

The following fields are exposed in the API:

Field Name Source Field Required Description
locationCode SMA Shipment Check Register."Location Code" Yes Code of the location where the item is stored.
itemNo SMA Shipment Check Register."Item No." Yes Unique identifier for the item.
lotNo SMA Shipment Check Register."Lot No." No Lot number of the item.
availableQty SMA Shipment Check Register.Quantity No Available quantity of the item in the lot.

Notes

  • The API calculates the available quantity by subtracting reserved quantities from the total quantity in the lot.

Example Usage

Retrieve Item Quantities By Lot

GET host/instance/api/smart/wms/v2.0/companies(companyId)/itemQtyByLots

Retrieve Specific Item Quantity By Lot

GET host/instance/api/smart/wms/v2.0/companies(companyId)/itemQtyByLots(locationCode='LOC001',itemNo='ITEM001',lotNo='LOT001')