API - Pallets

Overview

The endpoint is a non-editable list of Pallets.

Data

Field List

Object Example

{
    "barcode": "00050000000000001101",
    "systemId": "2b1f012c-34b6-ef11-b019-f3051338724d",
    "palletNo": "000000000110",
    "physicalPalletId": "99050000000000001101",
    "locationCode": "BLUE",
    "stockCenterId": "4a7c9e12-34b6-ef11-b019-f3051338724d",
    "stockCenterCode": "STOR-CUST-1",
    "fishingTripNo": "",
    "ownItems": false,
    "storageItems": true,
    "grossWeight": 0,
    "palletStandardCode": "",
    "keyItemId": "00684ed0-9ea1-ef11-b017-aa2d6f3d6955",
    "keyItemNo": "0900",
    "keyItemDescription": "Þorskflök, 10kg box",
    "itemCategoryId": "00000000-0000-0000-0000-000000000000",
    "itemCategoryCode": "",
    "noOfTIs": 40,
    "maximumTradeItems": 40,
    "quantity": 400,
    "incomingQuantity": 0,
    "totalQuantity": 400,
    "status": "Full",
    "containsLot": "LOT0044",
    "firstExpirationDate": "0001-01-01",
    "tradeItemsOnHoldStatus": 0,
    "agreementType": "Storage Shipment",
    "agreementNo": "SS-003",
    "zoneCode": "STORAGE",
    "binCode": "RECEIVING",
    "aisleCode": "",
    "pickingStatus": " ",
    "scheduledTripNo": "",
    "transportUnitID": 0,
    "loaded": false,
    "loadingDateTime": "0001-01-01T00:00:00Z",
    "dateCreated": "2024-12-09",
    "systemRowVersion": 2583310,
    "lastModified": "2025-10-21T15:46:14.383Z",
    "modifiedByUser": ""
}

Procedures

Actions are called on a specific pallet: POST pallets('<barcode>')/Microsoft.NAV.<actionName> with a JSON body of parameters. Each action returns a text message on success. On failure it returns an error with a readable message.

Trade items

Add Trade Item

To add a trade item to a pallet, the trade item stage and line no. are given as parameters to procedure addTradeItem:

POST
.../pallets([record-id])/Microsoft.NAV.addTradeItem

Body:
{
    "tradeItemStage" : "PS1",
    "tradeItemLine" : 11
}

Possible errors:

• Pallet with barcode <barcode> does not exist.

• The trade item stage/line does not exist (standard Business Central error).

• Trade Item <Stage>-<Line No.> and pallet <Pallet No.> have different reservations. The trade item cannot be added to the pallet.

• Pallet <Pallet No.> has status <Status> that does not allow adding trade items. (when the pallet status is Full or Reserved)

• Trade Item <Stage>-<Line No.> has item <Item No.>, which does not match key item <Key Item No.> on pallet <Pallet No.>. (when item mixing is not allowed)

• Trade Item <Stage>-<Line No.> has lot <Lot>, which does not match lot <Lot> on pallet <Pallet No.>. (when lot mixing is not allowed)

• Any error from removing the trade item from its previous pallet.

• Parameter <name> is too long (<n> characters), the maximum is <max>.

Add Barcoded Trade Item

To add a trade item to a pallet using the trade item barcode, use procedure addBarcodedTradeItem:

POST
.../pallets([record-id])/Microsoft.NAV.addBarcodedTradeItem

Body:
{
    "tradeItemBarcode" : "0123456789012345678901"
}

Possible errors:

• Pallet with barcode <barcode> does not exist.

• Trade Item with barcode <barcode> not found.

• Trade Item <Stage>-<Line No.> and pallet <Pallet No.> have different reservations. The trade item cannot be added to the pallet.

• Pallet <Pallet No.> has status <Status> that does not allow adding trade items. (when the pallet status is Full or Reserved)

• Trade Item <Stage>-<Line No.> has item <Item No.>, which does not match key item <Key Item No.> on pallet <Pallet No.>. (when item mixing is not allowed)

• Trade Item <Stage>-<Line No.> has lot <Lot>, which does not match lot <Lot> on pallet <Pallet No.>. (when lot mixing is not allowed)

• Any error from removing the trade item from its previous pallet.

• Parameter <name> is too long (<n> characters), the maximum is <max>.

Remove Trade Item

To remove a trade item from a pallet, the trade item stage and line no. are given as parameters to procedure removeTradeItem:

POST
.../pallets([record-id])/Microsoft.NAV.removeTradeItem

Body:
{
    "tradeItemStage" : "PRODUCTION",
    "tradeItemLine" : 64
}

Possible errors:

• Pallet with barcode <barcode> does not exist.

• The trade item stage/line does not exist (standard Business Central error).

• Trade Item <Stage>-<Line No.> is not on pallet <Pallet No.>.

• Parameter tradeItemStage is too long (<n> characters), the maximum is 20.

Remove Barcoded Trade Item

To remove a trade item from a pallet using the trade item barcode, use procedure removeBarcodedTradeItem:

POST
.../pallets([record-id])/Microsoft.NAV.removeBarcodedTradeItem

Body:
{
    "tradeItemBarcode" : "0123456789012345678901"
}

Possible errors:

• Pallet with barcode <barcode> does not exist.

• Trade Item with barcode <barcode> not found.

• Trade Item <Stage>-<Line No.> is not on pallet <Pallet No.>.

• Parameter tradeItemBarcode is too long (<n> characters), the maximum is 22.

Reservation

Reservation requires the pallet to be available for reservation. Otherwise an error message explains why.

Reserve to an Agreement

To reserve a pallet for a delivery agreement, the number of the agreement is given as a parameter to procedure reserveToAgreement:

POST
.../pallets([record-id])/Microsoft.NAV.reserveToAgreement

Body:
{
    "agreement" : "DA-0123"
}

Possible errors (checked in this order):

• Pallet Status is <Status>! (when the pallet status is Empty or Gone)

• There are no Trade Items on the pallet!

• A trade item on the pallet is not available. The error message is the reason:

  • Reserved for <Agreement Type> <Agreement No.>

  • Reserved for journal entry.

  • Reserved for outbound document.

  • Reserved for consumption entry.

  • <Hold Status> <Hold Reason Code> (when the trade item is on hold)

• Pallet is mixed with different item numbers, cannot find suitable agreement line!

• No suitable agreement line found for pallet <Pallet Barcode>! (when no line on the delivery agreement has the pallet's key item no. and a matching lot code filter / original lot filter). Note that this message shows the pallet barcode, not the pallet no.

• Errors from the Wisefish reservation itself (standard Wisefish/Business Central errors), for example if the agreement does not exist.

Reserve to an Agreement Line

To reserve a pallet for a delivery agreement line, both the agreement number and the line no. are given as parameters to procedure reserveToAgreementLine:

POST
.../pallets([record-id])/Microsoft.NAV.reserveToAgreementLine

Body:
{
    "agreement" : "DA-0123",
    "agreementLineNo" : 20000
}

Possible errors (checked in this order):

• Pallet Status is <Status>! (when the pallet status is Empty or Gone)

• There are no Trade Items on the pallet!

• A trade item on the pallet is not available. The error message is the reason:

  • Reserved for <Agreement Type> <Agreement No.>

  • Reserved for journal entry.

  • Reserved for outbound document.

  • Reserved for consumption entry.

  • <Hold Status> <Hold Reason Code> (when the trade item is on hold)

• Pallet is mixed with different item numbers, cannot find suitable agreement line!

• No suitable agreement line found for pallet <Pallet Barcode>! (when the given agreement line does not have the pallet's key item no. and a matching lot code filter / original lot filter). Note that this message shows the pallet barcode, not the pallet no.

• Errors from the Wisefish reservation itself (standard Wisefish/Business Central errors), for example if the agreement does not exist.

Unreserve

To remove the agreement reservation of a pallet, the following method is used:

POST
.../pallets([record-id])/Microsoft.NAV.unreserve

(no parameters)

If successful, the pallet is no longer reserved on the Agreement.

Possible errors:

• If the pallet is not reserved (no agreement no. on the pallet): a standard Business Central error (no delivery agreement line found).

• If there are no trade items on the pallet: a standard Business Central error.

• Errors from the Wisefish release of the reservation.

Loading

Load to Transport Unit

To load a pallet to a transport unit, use procedure loadToTransportUnit:

POST
.../pallets([record-id])/Microsoft.NAV.loadToTransportUnit

Body:
{
    "transportUnit" : 354
}

Possible errors:

• Transport Unit ID cannot be 0.

• Transport Unit with ID <ID> not found.

• Status of Transport Unit <ID> is <Status>, loading a pallet is not allowed. (when the transport unit status is Cancelled, InTransport or TransportCompleted)

• Pallet <Pallet No.> is already loaded to Transport Unit <ID>.

• Pallet <Pallet No.> is not reserved to any agreement, it cannot be loaded.

Unload from Transport Unit

To unload a pallet from a transport unit, use procedure unloadFromTransportUnit:

POST
.../pallets([record-id])/Microsoft.NAV.unloadFromTransportUnit

Body:
{
    "transportUnit" : 354
}

Possible errors:

• Pallet with barcode <barcode> does not exist.

• Transport Unit ID cannot be 0.

• Transport Unit with ID <ID> not found.

• Status of Transport Unit <ID> is <Status>, unloading a pallet is not allowed. (when the transport unit status is Cancelled, InTransport or TransportCompleted)

• Pallet <Pallet No.> is not loaded to Transport Unit <ID>.

Examples

Read pallets

Read Full pallets

For example, to read all pallets that are Full:

GET .../pallets?$filter=status eq 'Full'

Read a single pallet

Reads one pallet by its Record ID (barcode). The response is one pallet object, as shown in Object Example.

GET .../pallets('0000111122223333600')

Read a pallet with its trade items

Adds the trade items on the pallet to the response with $expand=openTradeItems (the trade item objects are shortened here).

Request:

GET .../pallets('0000111122223333600')?$expand=openTradeItems

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#pallets(openTradeItems())/$entity",
    "barcode": "0000111122223333600",
    "systemId": "7d2e41a8-5c90-f011-b01f-c3a1e2b9d417",
    "palletNo": "000000000110",
    "physicalPalletId": "",
    "locationCode": "BLUE",
    "stockCenterId": "4a7c9e12-34b6-ef11-b019-f3051338724d",
    "stockCenterCode": "STOR-CUST-1",
    "fishingTripNo": "",
    "ownItems": true,
    "storageItems": false,
    "grossWeight": 0,
    "palletStandardCode": "",
    "keyItemId": "00684ed0-9ea1-ef11-b017-aa2d6f3d6955",
    "keyItemNo": "0900",
    "keyItemDescription": "Þorskflök, 10kg box",
    "itemCategoryId": "00000000-0000-0000-0000-000000000000",
    "itemCategoryCode": "",
    "noOfTIs": 2,
    "maximumTradeItems": 40,
    "quantity": 20,
    "incomingQuantity": 0,
    "totalQuantity": 20,
    "status": "Open",
    "containsLot": "LOT0044",
    "firstExpirationDate": "0001-01-01",
    "tradeItemsOnHoldStatus": 0,
    "agreementType": "Delivery",
    "agreementNo": "",
    "zoneCode": "",
    "binCode": "",
    "aisleCode": "",
    "pickingStatus": " ",
    "scheduledTripNo": "",
    "transportUnitID": 0,
    "loaded": false,
    "loadingDateTime": "0001-01-01T00:00:00Z",
    "dateCreated": "2025-10-20",
    "systemRowVersion": 2590114,
    "lastModified": "2025-10-21T09:12:40.117Z",
    "modifiedByUser": "",
    "openTradeItems": [
        {
            "systemId": "b3c8f0a2-6d91-f011-b01f-c3a1e2b9d417",
            "stage": "PS1",
            "lineNo": 11,
            "itemNo": "0900",
            "description": "Þorskflök, 10kg box",
            "lot": "LOT0044",
            "tradeItems": 1,
            "tradeItemUnitOfMeasure": "BOX",
            "quantityBase": 10,
            "baseUnitOfMeasure": "KG",
            "palletBarcode": "0000111122223333600",
            "palletNo": "000000000110",
            "tradeItemBarcode": "",
            "holdStatus": " ",
            "reservedToDocumentType": "Delivery",
            "reservedToDocumentNo": ""
        },
        {
            "systemId": "b4c8f0a2-6d91-f011-b01f-c3a1e2b9d417",
            "stage": "PS1",
            "lineNo": 12,
            "itemNo": "0900",
            "description": "Þorskflök, 10kg box",
            "lot": "LOT0044",
            "tradeItems": 1,
            "tradeItemUnitOfMeasure": "BOX",
            "quantityBase": 10,
            "baseUnitOfMeasure": "KG",
            "palletBarcode": "0000111122223333600",
            "palletNo": "000000000110",
            "tradeItemBarcode": "",
            "holdStatus": " ",
            "reservedToDocumentType": "Delivery",
            "reservedToDocumentNo": ""
        }
    ]
}

Add and remove trade items

Add a trade item by stage and line

Adds trade item PS1-11 to pallet 0000111122223333600 using addTradeItem.

Request:

POST
.../pallets('0000111122223333600')/Microsoft.NAV.addTradeItem

Body:
{
    "tradeItemStage" : "PS1",
    "tradeItemLine" : 11
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Trade Item PS1-11 added to pallet 000000000110."
}

Add a trade item by barcode

Adds the trade item with barcode 0123456789012345678901 to pallet 00050000000000001101 using addBarcodedTradeItem.

Request:

POST
.../pallets('00050000000000001101')/Microsoft.NAV.addBarcodedTradeItem

Body:
{
    "tradeItemBarcode" : "0123456789012345678901"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Trade Item PRODUCTION-64 added to pallet 000000000110."
}

Remove a trade item by stage and line

Removes trade item PRODUCTION-64 from pallet 00050000000000001101 using removeTradeItem.

Request:

POST
.../pallets('00050000000000001101')/Microsoft.NAV.removeTradeItem

Body:
{
    "tradeItemStage" : "PRODUCTION",
    "tradeItemLine" : 64
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Trade Item PRODUCTION-64 removed from pallet 000000000110."
}

Remove a trade item by barcode

Removes the trade item with barcode 0123456789012345678901 from pallet 00050000000000001101 using removeBarcodedTradeItem.

Request:

POST
.../pallets('00050000000000001101')/Microsoft.NAV.removeBarcodedTradeItem

Body:
{
    "tradeItemBarcode" : "0123456789012345678901"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Trade Item PRODUCTION-64 removed from pallet 000000000110."
}

Reserve and unreserve

Reserve a pallet to an agreement

Reserves pallet 00123456789 to delivery agreement SA000123 using reserveToAgreement.

POST .../pallets('00123456789')/Microsoft.NAV.reserveToAgreement
{ "agreement": "SA000123" }

Reserve a pallet to an agreement line

Reserves pallet 0000111122223333600 to line 10000 of delivery agreement SA000123 using reserveToAgreementLine.

Request:

POST
.../pallets('0000111122223333600')/Microsoft.NAV.reserveToAgreementLine

Body:
{
    "agreement" : "SA000123",
    "agreementLineNo" : 10000
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Pallet 000000000110 successfully reserved for SA000123"
}

Unreserve a pallet

Releases the reservation of pallet 0000111122223333600 using unreserve.

Request:

POST
.../pallets('0000111122223333600')/Microsoft.NAV.unreserve

(no parameters)

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Pallet 000000000110 successfully un-reserved for SA000123."
}

Load and unload

Load a pallet to a transport unit

Loads pallet 00050000000000001101 to transport unit 354 using loadToTransportUnit.

Request:

POST
.../pallets('00050000000000001101')/Microsoft.NAV.loadToTransportUnit

Body:
{
    "transportUnit" : 354
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Pallet 000000000110 successfully loaded to Transport Unit 354."
}

Unload a pallet from a transport unit

Unloads pallet 00050000000000001101 from transport unit 354 using unloadFromTransportUnit.

Request:

POST
.../pallets('00050000000000001101')/Microsoft.NAV.unloadFromTransportUnit

Body:
{
    "transportUnit" : 354
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Pallet 000000000110 successfully unloaded from Transport Unit 354."
}