Posted Warehouse Shipments API

Overview

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

API Details

Publisher: smart
API Group: wms
API Version: v2.0
Entity Name: postedWhseShipmentWH
Entity Set Name: postedWhseShipmentsWH
Source Table: SMA Posted Whse. Shipment WH
ODataKeyFields: Entry No.

Fields

The following fields are exposed in the API:

Field Name	Source Field	Required	Description
`EntryNo`	`SMA Posted Whse. Shipment WH."Entry No."`	Yes	Unique identifier for the shipment entry.
`No`	`SMA Posted Whse. Shipment WH."No."`	Yes	Document number of the shipment.
`PostingDate`	`SMA Posted Whse. Shipment WH."Posting Date"`	No	Date the shipment was posted.
`ShipmentDate`	`SMA Posted Whse. Shipment WH."Shipment Date"`	No	Date the shipment was made.
`ShipmentTime`	`SMA Posted Whse. Shipment WH."Shipment Time"`	No	Time the shipment was made.
`SourceDocument`	`SMA Posted Whse. Shipment WH."Source Document"`	No	Source document associated with the shipment.
`SourceNumber`	`SMA Posted Whse. Shipment WH."Source Number"`	No	Source number associated with the shipment.
`DeliveryRouteSheet`	`SMA Posted Whse. Shipment WH."Delivery Route Sheet No."`	No	Delivery route sheet number.

Example Usage

Retrieve a Posted Warehouse Shipment

GET host/instance/api/smart/wms/v2.0/companies(companyId)/postedWhseShipmentsWH('EntryNo')

Example Response

{
    "EntryNo": 1001,
    "No": "SHIP001",
    "PostingDate": "2023-10-01",
    "ShipmentDate": "2023-10-01",
    "ShipmentTime": "10:30:00",
    "SourceDocument": "SALES ORDER",
    "SourceNumber": "SO001",
    "DeliveryRouteSheet": "DRS001"
}

Overview​

API Details​

Fields​

Example Usage​

Retrieve a Posted Warehouse Shipment​

Example Response​