Warehouse Pick Header API

Overview

The WMS Warehouse Pick Header API is a Business Central API page designed to manage warehouse pick header data. This API allows external systems to interact with warehouse pick headers, providing functionality for retrieving and managing pick header information.

API Details

• Publisher: smart
• API Group: wms
• API Version: v2.0
• Entity Name: dmWarehousePickHeader
• Entity Set Name: dmWarehousePickHeaders
• Source Table: Warehouse Activity Header
• ODataKeyFields: SystemId

Fields

The following fields are exposed in the API:

Field Name	Source Field	Required	Description
id	Warehouse Activity Header.SystemId	No	Unique identifier for the pick header.
no	Warehouse Activity Header."No."	Yes	Document number of the pick header.
type	Warehouse Activity Header.Type	Yes	Type of the warehouse activity.
subType	Warehouse Activity Header.Type.AsInteger()	No	Subtype of the warehouse activity.
locationCode	Warehouse Activity Header."Location Code"	Yes	Location code for the pick header.
assignedUserId	Warehouse Activity Header."Assigned User ID"	No	User assigned to the pick header.
warehouseReceiptCode	Derived from WhseDocNo	No	Warehouse receipt code.
purchaseHeaderCode	Derived from SourceNo	No	Purchase header code.
zoneCode2	Warehouse Activity Header."SMA Zone Code 2"	No	Secondary zone code.
prodOrderSourceNo	Derived from ProdOrderSourceNo	No	Production order source number.
prodOrderNo	Derived from ProdOrderNo	No	Production order number.
shipmentDate	Derived from ShipmentDate	No	Shipment date for the pick header.
pickingTareId	Warehouse Activity Header."SMA Warehouse Tare ID"	No	Picking tare identifier.
revisionZone	Warehouse Activity Header."SMA Revision Zone"	No	Revision zone for the pick header.
customerNo	Derived from CustomerNo	No	Customer number associated with the pick header.
customerName	Derived from CustomerName	No	Customer name associated with the pick header.
originalPickNo	Derived from OriginalPickNo	No	Original pick number.
salesOrderNo	Derived from SalesOrderNo	No	Sales order number associated with the pick header.
priority	Warehouse Activity Header."SMA Priority"	No	Priority of the pick header.
pickingMethod	Warehouse Activity Header."SMA Picking Method"	No	Picking method used.

Notes

• The warehousePickLines part provides access to related warehouse pick lines.

Example Usage

Retrieve a Warehouse Pick Headers

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

Update a Warehouse Pick Header

PATCH host/instance/api/smart/wms/v2.0/companies(companyId)/dmWarehousePickHeaders('id')
Content-Type: application/json

{
    "assignedUserId": "USER001",
    "priority": "High"
}