API - Pallets | Wisefish Manuals

Overview

The endpoint is a non-editable list of Pallets.

Endpoint name	`pallets`
Source table	`WiFi Pallet Entry`
Fixed view	Only shows pallets that are do still exist, i.e. have not been shipped away.
Requests allowed	GET
Primary key	`barcode`
Record ID	`barcode`
Procedures	`reserveToAgreement`, `unreserve`, `loadToTransportUnit`

Data

Field List

	Property	Type	Format	Description
1	`systemId`	string	uuid	SystemId
2	`barcode`	string	max 20	Barcode	PRIMARY KEY Record ID
3	`palletNo`	string	max 20	Pallet No.
4	`physicalPalletId`	string	max 20	Physical Pallet ID
5	`locationCode`	string	max 10	Location Code
6	`stockCenterCode`	string	max 20	Stock Center Code
7	`fishingTripNo`	string	max 20	Fishing Trip No.
8	`ownItems`	boolean
9	`storageItems`	boolean		If it is a stored pallet owned by another company.
10	`grossWeight`	number		Gross Weight (Manual)
11	`palletStandardCode`	string	max 20	Pallet Standard Code
12	`keyItemNo`	string	max 20	Key Item No. may be blank at creation, it will be populated when items are posted on the pallet.
13	`keyItemDescription`	string	max 100	The key item description
14	`itemCategoryCode`	string	max 20	Item Category Code
15	`noOfTIs`	number
16	`status`	string	enum	For example Empty, Open or Full
17	`containsLot`	string	max 10
18	`firstExpirationDate`	string	date
19	`tradeItemsOnHoldStatus`	string	enum
20	`agreementType`	string	enum	Usually “Delivery” but can be “Production”
21	`agreementNo`	string	max 20
22	`zoneCode`	string	max 10	Zone Code, if pallet warehouse is used.
23	`binCode`	string	max 10	Bin Code, if pallet warehouse is used.
24	`scheduledTripNo`	string	max 20
25	`transportUnitID`	integer
26	`loadingDateTime`	string	date-time
27	`dateCreated`	string	date	Date of creation
28	`lastModified`	string	date-time
29	[obsoleted fields]			Fields at the bottom are fields to be obsoleted.

Object Example

JSON

{
    "barcode": "00050000000000001101",
    "systemId": "2b1f012c-34b6-ef11-b019-f3051338724d",
    "palletNo": "000000000110",
    "physicalPalletId": "99050000000000001101",
    "locationCode": "BLUE",
    "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,
    "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",
    "lastModified": "2025-10-21T15:46:14.383Z",
    "lotCode": "LOT0044",
    "reservationStatus": " "
},

Usage

For example to read all pallet with that are Full:

JSON

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

Reserving

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:

JSON

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

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

Parameters
`agreement`	Give the delivery agreement number

The API will look for a line on this agreement that fits this pallet.

If reservation is successful, the trade item is shown on the Delivery Agreement as reserved.

Reserve to an Agreement Line

To reserve a pallet for a delivery agreement line, the both agreement number and line is given in a procedure with a name reserveToAgreementLine:

JSON

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

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

Parameters
`agreement`	Give the delivery agreement number
`agreementlineNo`	Give the agreement line number

If reservation is successful, the trade item is shown on the Delivery Agreement as reserved.

Unreserve

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

JSON

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

(no parameters)

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

The pallet is unreserved.

Shipping

Load to Transport Unit

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

JSON

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

Body:
{
    "transportUnit" : 354
}

Parameters
`transportUnit`	A transport unit is an integer.

When a pallet has been loaded to a transport unit it should get

a Scheduled Trip
a Transport Unit ID
Loaded = true