Posting Queue API

Overview

The WMS Posting Queue API is a Business Central API page designed to manage the posting queue for orders. This API allows external systems to interact with the posting queue, providing functionality for creating, reading, and validating posting queue entries.

API Details

• Publisher: smart
• API Group: wms
• API Version: v2.0
• Entity Name: orderPostingQueue
• Entity Set Name: orderPostingQueues
• Source Table: SMA Order Posting Queue
• ODataKeyFields: Entry No.

Fields

The following fields are exposed in the API:

Field Name	Source Field	Required	Description
EntryNo	SMA Order Posting Queue."Entry No."	No	Unique identifier for the posting queue entry.
SourceDocument	SMA Order Posting Queue."Source Document"	Yes	Type of the source document (e.g., Sales Order, Purchase Order).
SourceNo	SMA Order Posting Queue."Source No."	Yes	Identifier of the source document.
PostingType	SMA Order Posting Queue."Posting Type"	Yes	Type of posting operation (e.g., Ship, Invoice).

Notes

• The API validates the existence of the source document before allowing the creation of a posting queue entry.

Example Usage

Create a New Posting Queue Entry

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

{
    "SourceDocument": "Sales Order",
    "SourceNo": "SO001",
    "PostingType": "Ship"
}

Retrieve a Posting Queue Entry

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

Update a Posting Queue Entry

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

{
    "PostingType": "Invoice"
}