Warehouse Shipment API

Overview

The WMS Warehouse Shipment WH API is a Business Central API page designed to manage warehouse shipment data. This API allows external systems to interact with warehouse shipment records, providing functionality for reading shipment information.

API Details

Publisher: smart
API Group: wms
API Version: v2.0
Entity Name: warehouseShipmentWH
Entity Set Name: warehouseShipmentsWH
Source Table: SMA Warehouse Shipment WH
ODataKeyFields: EntryNo

Fields

The following fields are exposed in the API:

Field Name	Source Field	Required	Description
`EntryNo`	`SMA Warehouse Shipment WH."Entry No."`	Yes	Unique identifier for the shipment entry.
`ShipmentDate`	`SMA Warehouse Shipment WH."Shipment Date"`	No	Date of the shipment.
`Status`	`SMA Warehouse Shipment WH.Status`	No	Status of the shipment.
`SourceDocument`	`SMA Warehouse Shipment WH."Source Document"`	No	Source document related to the shipment.
`SourceNo`	`SMA Warehouse Shipment WH."Source No."`	No	Source number associated with the shipment.
`ItemNo`	`SMA Warehouse Shipment WH."Item No"`	No	Item number included in the shipment.
`QtyCanceled`	`SMA Warehouse Shipment WH."Qty Canceled"`	No	Quantity canceled for the shipment.
`LotNo`	`SMA Warehouse Shipment WH."Lot No."`	No	Lot number associated with the shipment.

Example Usage

Retrieve a Warehouse Shipments

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

Example Response

{
    "EntryNo": 1001,
    "ShipmentDate": "2023-10-01",
    "Status": "Released",
    "SourceDocument": "Sales Order",
    "SourceNo": "SO001",
    "ItemNo": "ITEM001",
    "QtyCanceled": 0,
    "LotNo": "LOT001"
}

Overview​

API Details​

Fields​

Example Usage​

Retrieve a Warehouse Shipments​

Example Response​