Table of Contents

Posting API

Overview

The WMS Order Posting API is a Business Central API page designed to handle the posting of WMS orders. This API allows external systems to trigger posting operations for orders and retrieve error messages related to the posting process.

API Details

  • Publisher: smart
  • API Group: wms
  • API Version: v2.0
  • Entity Name: orderPost
  • Entity Set Name: orderPosting
  • ODataKeyFields: ID

Fields

The following fields are exposed in the API:

Field Name Source Field Required Description
SourceDocument "SMA Source Document" Yes The source document type ("Sales Order","Purchase Order","Transfer Order").
SourceNo "SMA Source No." Yes The source document number.
PostingType Posting Type Yes The type of posting (Normal, Shipment, Receipt).
ID ID No Unique identifier.
MessageType "Message Type" No The type of message (e.g., error, warning).
Description Message No Detailed description of the error message.

Sub-Entities

Shipment Errors

This API includes a sub-entity for shipment errors:

  • Entity Name: shpmtError
  • Entity Set Name: shpmtErrors
  • SubPageLink: Links to the error message entry using the ID field.

Example Usage

Post a Warehouse Shipment for Sales Order

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

{
     "SourceDocument": "Sales Order",
     "SourceNo": "SALES001",
     "PostingType": "Shipment",
     "ID": 1
}