Overview
The endpoint is specifically designed to register a Pallet into BC which already has a barcode.
Default values for the pallet can be derived from User Profile or Vessel.
After a pallet has been created, it can be used to post items on it.
|
Endpoint name |
|
|
Source table |
|
|
Fixed view |
If used with GET it will only show pallets with Status Precreated and Empty. |
|
Requests allowed |
POST |
|
Primary key |
|
|
Record ID |
|
|
Procedures |
|
Data
Field List
|
Property |
Type |
Max Len |
Description |
|
|
|---|---|---|---|---|---|
|
1 |
|
string uuid |
|
SystemId |
non-editable |
|
2 |
|
string |
20 |
Barcode |
PRIMARY KEY Record ID |
|
3 |
|
string |
20 |
Pallet No. Will be generated out of the barcode after insert. |
non-editable |
|
4 |
|
string |
20 |
Physical Pallet ID |
|
|
5 |
|
string |
10 |
Location Code |
OPTIONAL |
|
6 |
|
string |
20 |
optionalStock Center Code |
OPTIONAL |
|
7 |
|
string |
20 |
Used when created for a Fishing Trip |
Mandatory if Fishing TripNo used |
|
8 |
|
string |
20 |
Fishing Trip No. |
OPTIONAL |
|
9 |
|
decimal |
|
Gross Weight (Manual) |
OPTIONAL |
|
10 |
|
string |
20 |
Pallet Standard Code |
|
|
11 |
|
string |
20 |
Key Item No. may be blank at creation, it will be populated when items are posted on the pallet. |
OPTIONAL |
|
12 |
|
string |
20 |
Item Category Code |
|
|
13 |
|
Status |
|
Status is usually Empty (Precreated is for an older feature). |
non-editable |
|
14 |
|
date |
|
Date of creation |
non-editable |
|
15 |
|
string |
10 |
Zone Code, if pallet warehouse is used. |
|
|
16 |
|
string |
10 |
Bin Code, if pallet warehouse is used. |
|
|
17 |
|
|
|
|
|
|
18 |
|
datetime |
|
|
non-editable |
Object Example
{
"systemId": "d2c2d8ae-f3d4-f011-b02a-d73020d2bf0c",
"barcode": "00066666667000000049",
"palletNo": "00000004",
"physicalPalletId": "99066666667000000049",
"vesselCode": "FREEZER",
"fishingTripNo": "FT-26-07",
"grossWeight": 0,
"palletStandardCode": "",
"keyItemNo": "",
"itemCategoryCode": "",
"locationCode": "BLUE",
"stockCenterCode": "FROSTI",
"status": "Empty",
"dateCreated": "2025-12-09",
"zoneCode": "",
"binCode": "",
"systemRowVersion": 4583353,
"lastModified": "2025-12-09T11:39:13.407Z"
}
Usage
Create a pallet with a specific barcode
Default stock center and location can be taken from the User Profile. Then the only required parameter is the barcode:
POST .../createPallets
BODY:
{
"barcode": "00066666667000000049"
}
To create a pallet with a pre-defined barcode and other values required
POST .../createPallets
BODY:
{
"barcode": "0000111122223333600",
"stockCenterCode" : "011",
"locationCode": "FREEZER_01"
}
The response contains all the properties in this API:
Create a pallet with a barcode for a specific Fishing Trip
To create a pallet for a specific Fishing Trip. In this case
-
the
vesselCodeis mandatory: -
Stock Center will be taken from the Vessel
POST .../createPallets
{
"barcode": "00066666667000000049",
"fishingTripNo": "FT-26-07",
"vesselCode": "FREEZER"
}
The response has all the properties of the object: