Table of Contents

Transfer Order API

Overview

The WMS Transfer Orders API is a Business Central API page designed to manage transfer order data. This API allows external systems to interact with transfer order records, providing functionality for creating, reading, and updating transfer orders.

API Details

  • Publisher: smart
  • API Group: wms
  • API Version: v2.0
  • Entity Name: transferOrder
  • Entity Set Name: transferOrders
  • Source Table: Transfer Header
  • ODataKeyFields: No

Fields

The following fields are exposed in the API:

Field Name Source Field Required Description
No Transfer Header."No." Yes Unique identifier for the transfer order.
TransferFrom Transfer Header."Transfer-from Code" Yes Code of the location transferring from.
TransferTo Transfer Header."Transfer-to Code" Yes Code of the location transferring to.
DirectTransfer Transfer Header."Direct Transfer" No Indicates if the transfer is direct.
Transit Transfer Header."In-Transit Code" No Code of the in-transit location.
PostingDate Transfer Header."Posting Date" Yes Date the transfer order was posted.
ShipmentDate Transfer Header."Shipment Date" Yes Date the transfer is scheduled for shipment.
ReceiptDate Transfer Header."Receipt Date" Yes Date the transfer is scheduled for receipt.
Status Transfer Header.Status No Current status of the transfer order.
ExternalDocumentNo Transfer Header."External Document No." No External reference number for the order.

Notes

  • The transferLines part is linked to the SMA Transfer Line API for managing transfer order lines.
  • The ReleaseAllMarked and Release procedures are service-enabled and can be used to release transfer orders. All records created via API are marked for release by default. You need to call the ReleaseAllMarked procedure to release all of them.

Example Usage

Create a New Transfer Order

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

{
    "No": "TO001",
    "TransferFrom": "LOC001",
    "TransferTo": "LOC002",
    "PostingDate": "2023-01-01",
    "ShipmentDate": "2023-01-05",
    "ReceiptDate": "2023-01-10",
    "DirectTransfer": false,
    "ExternalDocumentNo": "EXT001"
}

Retrieve a Transfer Order

GET host/instance/api/smart/wms/v2.0/companies(companyId)/transferOrders('TO001')

Update a Transfer Order

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

{
    "ShipmentDate": "2023-01-10",
    "ReceiptDate": "2023-01-15"
}

Release a Transfer Order

POST host/instance/api/smart/wms/v2.0/companies(companyId)/transferOrders('TO001')/Microsoft.NAV.release

Release All Marked Transfer Orders

POST host/instance/api/smart/wms/v2.0/companies(companyId)/transferOrders/Microsoft.NAV.releaseAllMarked
Edit this page