Breadcrumbs

API - Create Pallet

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

createPallets

Source table

WiFi Pallet Entry

Fixed view

If used with GET it will only show pallets with Status Precreated and Empty.

Requests allowed

GET, POST

Primary key

barcode

Record ID

barcode

Procedures

None

If stockCenterCode or locationCode is not given (and the Stock Center is not taken from a Vessel), the value is taken from the User Profile, which must then have it set.

Pallets for a Fishing Trip

To create a pallet for a specific Fishing Trip, the fishingTripNo is given. In this case:

  • the vesselCode is not mandatory (the API does not require it), but it is normally given with the fishingTripNo.

  • Stock Center will be taken from the Vessel, if stockCenterCode is not given. The Vessel must then exist.

  • The vesselCode is only used to get the Stock Center. It is not saved on the pallet, so it is empty when pallets are read with GET.

Data

Field List

Property

Type

Format

Description


1

systemId

string

uuid

SystemId

non-editable

2

barcode

string

max 20

Barcode

Record ID

primary key

3

palletNo

string

max 20

Pallet No. Will be generated out of the barcode after insert.

non-editable

4

physicalPalletId

string

max 20

Physical Pallet ID

optional

5

locationCode

string

max 10

Location Code

optional

6

stockCenterCode

string

max 20

Stock Center Code

optional

7

vesselCode

string

max 20

Used when created for a Fishing Trip. Not required: if it is given and stockCenterCode is not, the Stock Center is taken from the Vessel. The value is not saved on the pallet.

optional

8

fishingTripNo

string

max 20

Fishing Trip No.

optional

9

grossWeight

number

decimal

Gross Weight (Manual)

optional

10

palletStandardCode

string

max 20

Pallet Standard Code

optional

11

keyItemNo

string

max 20

Key Item No. may be blank at creation, it will be populated when items are posted on the pallet.

optional

12

itemCategoryCode

string

max 20

Item Category Code

optional

13

status

string

enum

Status is usually Empty (Precreated is for an older feature). Options: Open, Full, Empty, Gone, Precreated

non-editable

14

dateCreated

string

date

Date of creation

optional

15

zoneCode

string

max 10

Zone Code, if pallet warehouse is used.

optional

16

binCode

string

max 20

Bin Code, if pallet warehouse is used.

optional

17

systemRowVersion

integer


System row version. Increments every time the record is modified.

non-editable

18

lastModified

string

date-time

SystemModifiedAt (date and time of last change)

non-editable


Object Example

JSON
{
    "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"
}

Examples

Read pallets

Read all new pallets

Reads all pallets with status Precreated or Empty (the fixed view of this endpoint). The response is a list of pallet objects, as shown in Object Example.

JSON
GET .../createPallets

Read one pallet

The Record ID is the barcode, so one pallet is read with a GET request on the following format:

JSON
GET .../createPallets('00066666667000000049')

Read new pallets on a location

Reads the empty pallets on location BLUE and returns only the barcode, pallet number and stock center with $select.

JSON
GET .../createPallets?$filter=locationCode eq 'BLUE'&$select=barcode,palletNo,stockCenterCode

Create pallets

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:

JSON
POST .../createPallets

BODY:
{
    "barcode": "00066666667000000049"
}

Create a pallet with a barcode, stock center and location

To create a pallet with a pre-defined barcode and other required values:

Request:

JSON
POST .../createPallets

BODY:
{
    "barcode": "0000111122223333600",
    "stockCenterCode" : "011",
    "locationCode": "FREEZER_01"
}

The response contains all the properties in this API:

JSON
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(f5a90234-4e79-f111-b037-cca9ad943c7c)/createPallets/$entity",
    "@odata.etag": "W/\"JzE5Ozg0MTU4NTUxNzE0MjcwNzA3MjAxOzAwOyc=\"",
    "barcode": "0000111122223333600",
    "systemId": "3d3ddc24-14bc-f111-b03e-b5c36009a6b9",
    "palletNo": "33360",
    "physicalPalletId": "9900111122223333600",
    "locationCode": "FREEZER_01",
    "stockCenterCode": "011",
    "vesselCode": "",
    "fishingTripNo": "",
    "grossWeight": 0,
    "palletStandardCode": "",
    "keyItemNo": "",
    "itemCategoryCode": "",
    "status": "Empty",
    "dateCreated": "2026-09-29",
    "zoneCode": "",
    "binCode": "",
    "systemRowVersion": 4816953,
    "lastModified": "2026-09-29T14:43:33.897Z"
}

Create a pallet with a barcode for a specific Fishing Trip

Creates a pallet for fishing trip FT-26-07 of vessel FREEZER; the Stock Center is taken from the Vessel.

Request:

JSON
POST .../createPallets

{
    "barcode": "00066666667000000049",
    "fishingTripNo": "FT-26-07",
    "vesselCode": "FREEZER"
}

The response has all the properties of the object:

JSON
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/createPallets/$entity",
    "@odata.etag": "W/\"JzIwOzExNTE2MTU3MjQ0MTA1NjAxODc0MTswMDsn\"",
    "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": 4816953,
    "lastModified": "2025-12-09T11:39:13.407Z"
}