Breadcrumbs

Base APIs - Endpoint Overview - TEST STATUS


Endpoint

Description

Link to Documentation

Requests available

Procedures

Status

Testing Status


1. Setup










userProfiles

Wisefish User Profiles


API - User Profiles

GET


PATCH



Released

GET - Done


locations

Locations


API - Locations

GET





Released

Done


stockCenters

Stock Centers with Certification Program Registers.

API - Stock Centers

GET

POST

PATCH

DELETE

createOriginLot

createProductionLot

Released

GET - Done

POST - Done

PATCH

DELETE - Done

CreateOrigin Lot: Done

CreateProductionLot: Done


processingStages

Processing Stages

API - Processing Stages

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


itemCategories

Item Categories

API - Item Categories

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


fishingAreas

Fishing Areas

API - Fishing Areas

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


landingTypes

Landing Types

API - Landing Types

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


rawMaterialSQGrades

Raw Material Size Quality Grades


GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


2. Master data










customers

Customers, the most important fields.

API - Customers

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


vendors

Vendors

API - Vendors

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


vessels

Vessels


GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


items

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


API - Items

GET





Released

GET - Done


itemDetails

Items with units and variants and the most important fields.


GET

POST

PATCH

POST


Released

GET - Done

POST - Done

PATCH

DELETE - Done


itemUnits

Item units.
Attached as child-entries on itemDetails

API - Item Units

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


itemVariants

Item variants. Attached as child-entries on itemDetails

API - Item Variants

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


certificationPrograms

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

API - Certification Programs

GET





Released

GET - Done

POST - NA

PATCH

DELETE - Done


comments

Comments, used as child entries on other endpoints.







Released


New Not Tested

3. Inventory










inventoryItems

List of inventory items with quantity in stock

API - Item Inventory

GET




transferQtyToLocation

transferQtyToLocationAndBin

Released

GET: Done

Document was missing before, added now, need to test.

inventoryTradeItems

Trade Items available in stock.

The entries from table “Open Trade Item“


GET





Released


New Not Tested

lots

Lots with catch origin and certifications.


API - Lots

GET

POST

PATCH

DELETE

See procedure on stockCenters to create

Released

GET - Done

POST - Done

PATCH- Done

DELETE - Done

Procedures: Pass

Tested Patch with etag

lotCertifications

Certification Programs for a Lot


GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH

DELETE - Done


lotGroups

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

API - Lot Groups

GET

POST

PATCH

DELETE


Released

GET - Done

POST - Done

PATCH- Done

DELETE - Done

Tested patch without using etag in header (If-Match = * )

pallets

Pallets, with items.


GET




reserveToAgreement

unreserve

loadToTransportUnit

Released

GET - Done

No document for the procedures so skipped testing

createPallet

Specific endpoint to create a pallet.


GET

POST




Released

GET - Done

POST- FAIL

shows an error as: Barcode must have a value in Pallet Entry: Barcode=. It cannot be zero or empty.

  • Could not test with fishing info as Fishing module is not installed in Sandox.

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

testing



purchaseAgreementLines

Purchase Agreement Lines, with type = Receipt/Blanket.

API - Purchase Agreement Lines

GET

POST

PATCH

DELETE


testing



closedPurchaseAgreements

Closed Purchase Agreements, with type = Receipt/Blanket


API - Purchase Agreements

GET





testing



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

GET: Done

release: Error

createPostingDocument: Done

createPostingDocumentAndPostShipment: Error

The release shows an error as “The update has been interrupted”.

Posting and shipment shows error: This function only supports Sales Orders!  CorrelationId:  6040f694-3c03-439a-afc4-7bdc5bd6006f.

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

GET - Done

POST - Done

PATCH- Done

DELETE - Done


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

GET - Done


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

GET - Done

POST - Done

PATCH- Done

DELETE - Done

updateQuantity: Done

updateUnitPrice: Done

updateQuantityAndUnitPrice: Done

reserveTradeItem: No doc

releaseTradeItem: No doc

reservePallet: Done

releasePallet: Done

Everything tested except Reserve and Unreserve Trade Items



extendedTexts

Extended texts can be added on agreements.


GET

POST

PATCH

n/a


testing

GET - Done

POST - Done

PATCH- Done


Logistics






scheduledTrips

Scheduled trips.


GET

POST

PATCH

DELETE


testing

Need some changes


transportUnits

Transport Units.


GET

POST

PATCH

DELETE


testing

GET: Only showed Released TU

POST: Done

PATCH: with TU in open status we are getting the error as resource not available and with released we get error as modify cannot be done for released

Delete: Only released can be deleted


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

GET: Done

POST: Done

PATCH: Done

DELETE: Done


Need to test the Procedure

outputJournalLines

Trade Item Output Journal.

Here the produced items are inserted.


API - Production Output

GET

POST

PATCH

DELETE


Released

GET: Done

POST: Done

PATCH:

DELETE: Done

I cannot use this, get Location error. (BJARTEY)

consumptionJournalLines

Trade Item Consumption Journal.

Here the consumed items are inserted.


GET

POST

PATCH

DELETE


Released

GET: Done

POST: Done

PATCH:

DELETE: Done


6. Warehouse










Standard











openPurchaseOrders


Receiving items on purchase orders, without using Warehouse Receipts

API - Open Purchase Orders

GET




postReceipt

testing


Not Tested

openPurchaseLines

The lines for openPurchaseOrders

API - Open Purchase Lines

GET


PATCH


updateQuantityToReceive

updateQuantityToReceiveToBin

createItemTracking

testing


Not Tested

warehouseReceipts


Warehouse Receipts, usually related to purchase orders

API - Warehouse Receipts

GET




receiveItem
receiveItemToBin

Released


Need Help, Not Tested

warehouseReceiptLines

The lines for warehouseReceipts







Released


Need Help, Not Tested

warehouseShipments

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

Not finished and perhaps not needed

GET




shipItem
shipItemFromBin

On hold



7. Change Log










changeLogEntries

The module logs changes on the main tables


GET




markAsRead

Released

GET: Done