Warehouse Worksheet Lines API

Overview

The WMS Warehouse Worksheet Lines API is a Business Central API page designed to manage warehouse worksheet line data. This API allows external systems to interact with warehouse worksheet lines, providing functionality for creating, reading, and updating worksheet line information.

API Details

Publisher: smart
API Group: wms
API Version: v2.0
Entity Name: whseWorksheetLine
Entity Set Name: whseWorksheetLines
Source Table: Whse. Worksheet Line

Fields

The following fields are exposed in the API:

Field Name	Source Field	Required	Description
`templateName`	`Whse. Worksheet Line."Worksheet Template Name"`	Yes	Name of the worksheet template.
`name`	`Whse. Worksheet Line.Name`	Yes	Name of the worksheet.
`lineNo`	`Whse. Worksheet Line."Line No."`	No	Line number of the worksheet.
`locationCode`	`Whse. Worksheet Line."Location Code"`	Yes	Code of the location.
`itemNo`	`Whse. Worksheet Line."Item No."`	Yes	Item number associated with the line.
`fromZoneCode`	`Whse. Worksheet Line."From Zone Code"`	No	Code of the source zone.
`toZoneCode`	`Whse. Worksheet Line."To Zone Code"`	No	Code of the destination zone.
`fromBinCode`	`Whse. Worksheet Line."From Bin Code"`	No	Code of the source bin.
`toBinCode`	`Whse. Worksheet Line."To Bin Code"`	No	Code of the destination bin.
`description`	`Whse. Worksheet Line.Description`	No	Description of the worksheet line.
`variantCode`	`Whse. Worksheet Line."Variant Code"`	No	Variant code of the item.
`unitOfMeasure`	`Whse. Worksheet Line."Unit of Measure Code"`	No	Unit of measure for the item.
`quantity`	`Whse. Worksheet Line.Quantity`	Yes	Quantity of the item.
`lotNo`	`LotNo`	No	Lot number associated with the item.

Notes

The lotNo field is optional but required when tracking items by lot.

Example Usage

Create a New Warehouse Worksheet Line

POST host/instance/api/smart/wms/v2.0/companies(companyId)/whseWorksheetLines
Content-Type: application/json

{
    "templateName": "DEFAULT",
    "name": "Worksheet001",
    "lineNo": 10000,
    "locationCode": "MAIN",
    "itemNo": "ITEM001",
    "quantity": 10,
    "lotNo": "LOT001"
}

Retrieve a Warehouse Worksheet Lines

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

Overview​

API Details​

Fields​

Notes​

Example Usage​

Create a New Warehouse Worksheet Line​

Retrieve a Warehouse Worksheet Lines​