Transfer Line API

Overview

The WMS Transfer Line API is a Business Central API page designed to manage transfer line data. This API allows external systems to interact with transfer line records, providing functionality for creating, reading, and updating transfer line information.

API Details

• Publisher: smart
• API Group: wms
• API Version: v2.0
• Entity Name: transferLine
• Entity Set Name: transferLines
• Source Table: Transfer Line
• ODataKeyFields: Document No., Line No.

Fields

The following fields are exposed in the API:

Field Name	Source Field	Required	Description
DocumentNo	Transfer Line."Document No."	Yes	Number of the transfer document.
LineNo	Transfer Line."Line No."	No	Line number of the transfer line.
ItemNo	Transfer Line."Item No."	Yes	Item number.
VariantCode	Transfer Line."Variant Code"	No	Variant code for the item.
Quantity	Transfer Line.Quantity	Yes	Quantity of the item.
QtytoShip	Transfer Line."Qty. to Ship"	No	Quantity to be shipped.
QtyToReceive	Transfer Line."Qty. to Receive"	No	Quantity to be received.
LotNo	Transfer Line."SMA Api Lot No"	No	Lot number for the item.

Notes

• The LineNo field is automatically generated and incremented by 10,000 for each new transfer line.

Example Usage

Create a New Transfer Line

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

{
    "DocumentNo": "TR001",
    "ItemNo": "ITEM001",
    "Quantity": 10,
    "LotNo": "LOT123"
}

Retrieve Transfer Lines

GET host/instance/api/smart/wms/v2.0/companies(companyId)/transferLines?$filter=DocumentNo eq 'TR001'

Update a Transfer Line

PATCH host/instance/api/smart/wms/v2.0/companies(companyId)/transferLines('TR001',10000)
Content-Type: application/json

{
    "Quantity": 15
}