Breadcrumbs

Base APIs - Endpoint Overview

This is an overview of the available endpoints. For each base path, there is a sub-page with more information.

  • Some data is non-editable because the data must always be set up within BC.

  • In some cases, new entries can only be created with a specific procedures, for example Lots.

  • Even if there is a POST, PATCH, DELETE option, the data is only editable, as long as it is still editable within Wisefish. For example, if a status does of an entry does not allow changes in BC, the functionality is the same when trying to modify with an API.


Endpoint

Description

Link to Documentation

Requests available

Procedures

Status

1. Setup








userProfiles

Wisefish User Profiles


API - User Profiles

GET


PATCH



Released

locations

Locations


API - Locations

GET





Released

stockCenters

Stock Centers with Certification Program Registers.

API - Stock Centers

GET

POST

PATCH

DELETE

createOriginLot

createProductionLot

Released

processingStages

Processing Stages

API - Processing Stages

GET

POST

PATCH

DELETE


Released

itemCategories

Item Categories

API - Item Categories

GET

POST

PATCH

DELETE


Released

fishingAreas

Fishing Areas

API - Fishing Areas

GET

POST

PATCH

DELETE


Released

landingTypes

Landing Types

API - Landing Types

GET

POST

PATCH

DELETE


Released

rawMaterialSQGrades

Raw Material Size Quality Grades


GET

POST

PATCH

DELETE


Released

2. Master data








customers

Customers, the most important fields.

API - Customers

GET

POST

PATCH

DELETE


Released

vendors

Vendors

API - Vendors

GET

POST

PATCH

DELETE


Released

vessels

Vessels


GET

POST

PATCH

DELETE


Released

items

Items, a simple list with the description of the item, unit of measure and prices.


API - Items

GET





Released

itemDetails

Items with units and variants and the most important fields.


GET

POST

PATCH

POST


Released

itemUnits

Item units.
Attached as child-entries on itemDetails

API - Item Units

GET

POST

PATCH

DELETE


Released

itemVariants

Item variants. Attached as child-entries on itemDetails

API - Item Variants

GET

POST

PATCH

DELETE


Released

certificationPrograms

The Certification Program Register.
Used as child-entries on other endpoints.

API - Certification Programs

GET





Released

comments

Comments, used as child entries on other endpoints.







Released

3. Inventory








inventoryItems

List of inventory items with quantity in stock

API - Item Inventory

GET




transferQtyToLocation

transferQtyToLocationAndBin

Released

inventoryTradeItems

Trade Items available in stock.

The entries from table “Open Trade Item“


GET





Released

lots

Lots with catch origin and certifications.


API - Lots

GET

POST

PATCH

DELETE

See procedure on stockCenters to create

Released

lotCertifications

Certification Programs for a Lot


GET

POST

PATCH

DELETE


Released

lotGroups

Lot Groups. These are groups to be added on Lots.

API - Lot Groups

GET

POST

PATCH

DELETE


Released

pallets

Pallets, with items.


GET




reserveToAgreement

unreserve

loadToTransportUnit

Released

createPallet

Specific endpoint to create a pallet.

API - Create Pallet

GET

POST




Released

4. Trading (Purchase & Sales)








Purchases




purchaseAgreements

Purchase Agreements that have not been posted, with type = Receipt/Blanket

API - Purchase Agreements

GET

POST

PATCH

DELETE

release

reopen

createPostingDocument

receiveItems

dev

purchaseAgreementLines

Purchase Agreement Lines, with type = Receipt/Blanket.

API - Purchase Agreement Lines

GET

POST

PATCH

DELETE


dev

closedPurchaseAgreements

Closed Purchase Agreements, with type = Receipt/Blanket


API - Purchase Agreements

GET





dev

Sales




salesAgreements


Delivery Agreements + Blankets, no matter of the Status.

These are all entries in the table and therefore the endpoint does not allow insert, modify and delete. But procedures are available but will return an error if not allowed.


API - Sales Agreements

GET




release

reOpen

createPostingDocument

createPostingDocumentAndPostShipment


testing

openSalesAgreements

Delivery Agreements + Blankets, but only the open agreements that can be modified.

API - Sales Agreements

GET

POST

PATCH

DELETE

Same endpoints as on salesAgreements

testing

closedSalesAgreements

Delivery Agreements + Blankets which are closed, i.e. with Status = Posting|Closed

API - Sales Agreements

GET




No procedures because these agreements have been posted.

testing

salesAgreementLines

The lines on Delivery Agreements + Blankets

Contains various endpoint procedures to simplify modifications and reserve items to sell.


API - Sales Agreement Lines

GET

POST

PATCH

DELETE

updateQuantity

updateUnitPrice

updateQuantityAndUnitPrice

reserveTradeItem

unreserveTradeItem

reservePallet

unreservePallet

testing

extendedTexts

Extended texts can be added on agreements.


GET

POST

PATCH

n/a


testing

Logistics




scheduledTrips

Scheduled trips.


GET

POST

PATCH

DELETE


testing

transportUnits

Transport Units.


GET

POST

PATCH

DELETE


testing

5. Production








productionLots

Production lots.


API - Production Lots

GET

POST

PATCH

DELETE

consumeItem

procudeItem

There is also a procedure on stockCenters to create a new lot.

Released

outputJournalLines

Trade Item Output Journal.

Here the produced items are inserted.



GET

POST

PATCH

DELETE


Released

consumptionJournalLines

Trade Item Consumption Journal.

Here the consumed items are inserted.


GET

POST

PATCH

DELETE


Released

6. Warehouse








Standard









openPurchaseOrders


Receiving items on purchase orders, without using Warehouse Receipts

API - Open Purchase Orders

GET




postReceipt

testing

openPurchaseLines

The lines for openPurchaseOrders

API - Open Purchase Lines

GET


PATCH


updateQuantityToReceive

updateQuantityToReceiveToBin

createItemTracking

testing

warehouseReceipts


Warehouse Receipts, usually related to purchase orders

API - Warehouse Receipts

GET




receiveItem
receiveItemToBin

Released

warehouseReceiptLines

The lines for warehouseReceipts







Released

warehouseShipments

Warehouse Shipments, i.e. the standard documents created for standard Sales Orders

Not finished

GET




shipItem
shipItemFromBin

On hold

7. Change Log








changeLogEntries

The module logs changes on the main tables


GET




markAsRead

Released