API - MES Shipment

Overview

The is an API to create a shipment transaction in the MES transaction queue.

• This API will create a new entry in table “MES Transaction Line”

• The header (MES Transaction) will be created automatically, if it does not already exist

• Modification is not allowed. If a wrong entry was created, it can be deleted and recreated, if its status allows.

• When a Shipment Transaction is processed by the MES posting routine:

  • If it’s a transaction linked to a Sales Order, reservation entries are created to keep track of what has been shipped. Posting the shipment is optional.

  • If it’s a transaction linked to a Delivery Agreement, trade item reservation and pallet contents are updated according to the data in the request. Posting the shipment is optional.

  
  

Data

Field List

Example Object

This is an example of the JSON object:

{
    "@odata.etag": "W/\"JzE5OzEyNzU2NDYyNzM1ODM4ODE1OTAxOzAwOyc=\"",
    "systemId": "a149be80-7450-f111-b032-9db86b18df8e",
    "transactionId": 536,
    "lineNo": 2,
    "terminal": "INNOVA",
    "externalReference": "1505-1",
    "documentType": "SalesAgreement",
    "documentNo": "DA-009",
    "shipmentDate": "2026-05-15",
    "location": "TRONDHEIM",
    "itemNo": "70064",
    "quantity": 50,
    "unitOfMeasure": "BOKS",
    "lot": "BAT-321",
    "tradeItemBarcode": "",
    "palletBarcode": "00066666667000000124",
    "palletNo": "",
    "reserveOnDocType": "SalesAgreement",
    "reserveOnDocNo": "DA-009",
    "reserveOnLineNo": 10000,
    "lastModified": "2026-05-15T15:41:14.16Z"
}

Automatic Fields

This is explained in more details in document MES Inbound - Error Handling & Validation but the main defaults and automatic population is as follows:

• Creation of the Transaction:

  • Type will be Shipment

  • Activity Date will be set as the shipmentDate property, or today if not given

  • If not given, Document Type will be set automatically after the documentNo has been searched for in the system.

  • For this API there is no property for Stock Center or Location, these values should get their default value from any of the following tables:

    • Terminal table

    • User Profile

• Creation of the Transaction Line:

  • Line No. is set automatically

Usage

Create a new transaction or add a line

The response will just show all the properties of the endpoint. An error response says that the entry was not created.

Pallet creation

A pallet can be created at the same time when a trade item is added on it, or when it is reserved on an agreement.

The following properties concern the pallet creation:

"palletBarcode"
"palletNo" - the pallet number is mandatory when creating a new pallet
"palletStatus" - may be left blank
"itemNo" - will become the Key Item No. on the pallet
"location" - a pallet is marked with a location
"stockCenter" - a pallet is marked with a stock center

The processing method does the following:

1. If a pallet exists, the properties of that pallet are compared to the properties of the API data: Stock Center, Location, Pallet No. and Item No.

   1. If any of those properties do not match, the transaction gets Status = Error and error description

2. In the same way, the palletNo, can be used to relate to an existing pallet.

3. Else, the pallet is created and ready to get trade items assigned to it.
   

Packing on pallets

Packing Trade Items on pallets is done by giving …

1. a pallet barcode (or a pallet number)

2. a specific relation to one Trade Item,

   1. This is most generally done by giving the tradeItemBarcode as a unique reference

   2. but if other properties will return the finding of one single Trade Item, this will also result in a successful entry. These properties are itemNo, lot and location

Example 1: Put a barcoded trade item on a new Pallet

The following API request will create a transaction to add a barcoded trade item (for example a box of seafood) on a pallet.

POST
.../mesShipment

{   
    "externalReference": "REF-NO-X",
    "itemNo": "70064",
    "tradeItemBarcode": "0123456"
    "palletBarcode": "00066666667000000124",
    "palletNo": "000012"
}

Example 2: Put a trade item with given lot and quantity on an existing Pallet

The following API request will add a trade item with given lot and quantity on a pallet that already exists:

POST
.../mesShipment

{   
    "externalReference": "REF-NO-X",
    "itemNo": "70064",
    "lot": "PROD180501"
    "quantity": 50,
    "unitOfMeasure": "BOX"
    "palletBarcode": "00066666667000000124"
}

Reservation changes (WF)

When using the following properties, reservation of Trade Items is done:

• reserveOnDocType

• reserveOnDocNo

• reserveOnLineNo

Example 3: Reserve a pallet on a Delivery Agreement

POST
.../mesShipment

{   
    "externalReference": "REF-NO-X",
    "reserveOnDocType": "Sales Agreement",
    "reserveOnDocNo": "DA-009",
    "reserveOnLineNo": "DA-009",
    "itemNo": "70064",
    "palletBarcode": "00066666667000000124"
}

Example 4: Reserve a trade item on a Delivery Agreement

POST
.../mesShipment

{   
    "externalReference": "REF-NO-X",
    "reserveOnDocType": "Sales Agreement",
    "reserveOnDocNo": "DA-009",
    "reserveOnLineNo": "DA-009",
    "itemNo": "70064",
    "tradeItemBarcode": "0123456" 
}

Of if the trade items do not have barcodes:

POST
.../mesShipment

{   
    "externalReference": "REF-NO-X",
    "reserveOnDocType": "Sales Agreement",
    "reserveOnDocNo": "DA-009",
    "reserveOnLineNo": "DA-009",
    "itemNo": "70064",
    "quantity": "100",
    "lot": "LOT-123" 
}

Example 5: Shipping for a Sales Order

POST
.../mesShipment

{   
    "externalReference": "REF-NO-X",
    "documentType": "Sales Order",
    "documentNo": "1003",
    "itemNo": "70064",
    "quantity": "100",
    "lot": "LOT-123"
}