API Documentation

Introduction

Nav24 ShopFloor provides multiple API interfaces that allow integration with external systems and ShopFloor applications. This document contains a detailed description of all available API endpoints, along with their fields and usage examples.

All API endpoints use API version v1.0 and require company context in the path /companies({companyID})/.

URL Format

All endpoints have the following format:

/api/nav24/{module}/v1.0/companies({companyID})/{resource}

where:

• {module} is the module name (e.g., prodOrderApi, inventoryApi, etc.)
• {companyID} is the company ID
• {resource} is the resource name

Table of Contents

1. Production API
2. Consumption API
3. Session API
4. Codes API
5. Inventory API
6. Employee API
7. Company API
8. Production Capacity API
9. Work Centers API

Production API

Production Output Entry API (prodOutputEntry)

Provides access to production output entries.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOutputEntries ReadWrite

Operations:

• GET - Get production output entries
• POST - Create production output entry
• PATCH - Update production output entry (/{recordGuid})

Field	Description
entryNo	Entry number
sessionId	Session ID
lineType	Line type
prodOrderNo	Production order number
prodOrderLineNo	Production order line number
itemNo	Item number
variantCode	Variant code
description	Description
comment	Comment
lotNo	Lot number
logisticUnitNo	Logistic unit number
serialNo	Serial number
quantity	Quantity
weight	Weight
postingDate	Posting date
productionOrderStatus	Production order status
type	Type
prodLine	Production line
operationNo	Operation number
workShiftCode	Work shift code
plannedUnitRunTime	Planned unit run time
runtime	Runtime
startingTime	Starting time
endingTime	Ending time
userName	User name
scrapStopCode	Scrap/stop code
deviceNo	Device number
labelQuantity	Label quantity
systemId	System ID

Notes:

• Supports write operations (ModifyAllowed = true)
• When inserting a new record, the system will automatically set default entry status
• Part of the nav24/prodOrderApi group

Detailed Production Output Entry API (detailedProdOutputEntry)

Provides access to detailed production output entries.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/detailedProdOutputEntries ReadWrite

Operations:

• GET - Get detailed production output entries
• POST - Create detailed production output entry

Field	Description
entryNo	Entry number
parentEntryNo	Parent entry number
lineType	Line type
no	Number
sessionId	Session ID
startingTime	Starting date and time
endingTime	Ending date and time
userName	User name
status	Status
systemId	System ID

Notes:

• When inserting a new record, the system will automatically set default data
• Part of the nav24/prodOrderApi group

Production Order Component API (prodOrderComponent)

Provides access to production order components.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderComponents ReadOnly

Operations:

• GET - Get production order components

Field	Description
systemId	System ID
status	Status
prodOrderNo	Production order number
prodOrderLineNo	Production order line number
lineNo	Line number
itemNo	Item number
variantCode	Variant code
description	Description
unitOfMeasureCode	Unit of measure code
quantity	Quantity
routingLinkCode	Routing link code
flushingMethod	Flushing method
locationCode	Location code
binCode	Bin code
remainingQuantity	Remaining quantity
expectedQuantity	Expected quantity
expectedQtyBase	Expected quantity (base)
remainingQtyBase	Remaining quantity (base)
skipInProdPanel	Skip in ShopFloor flag
lotRequired	Lot tracking required
serialRequired	Serial tracking required

Notes:

• Contains information about lot/serial tracking requirements

Consumption API

Consumption Entry API (consumptionEntry)

Provides access to consumption entries.

Endpoint: /api/nav24/consumptionApi/v1.0/companies({companyID})/consumptionEntries ReadWrite

Operations:

• GET - Get consumption entries
• POST - Create consumption entry

Field	Description
entryNo	Entry number
sessionId	Session ID
orderStatus	Order status
prodOrderNo	Production order number
prodOrderLineNo	Production order line number
locationCode	Location code
binCode	Bin code
itemNo	Item number
variantCode	Variant code
logisticUnitNo	Logistic unit number
lotNo	Lot number
description	Description
quantity	Quantity
postingDate	Posting date
workShiftCode	Work shift code
userName	User name
deviceNo	Device number
systemId	System ID

Notes:

• When inserting a new record, the system will automatically set default entry status
• Part of the nav24/consumptionApi group

Session API

Session Status API (sessionStatus)

Provides access to session statuses.

Endpoint: /api/nav24/session/v1.0/companies({companyID})/sessionsStatusEntries ReadWrite

Operations:

• GET - Get session statuses
• POST - Create new session status
• DELETE - Delete session status (/{recordGuid})

Field	Description
systemId	System ID
entryNo	Entry number
sessionId	Session ID
type	Type
prodOrderNo	Production order number
prodOrderLineNo	Production order line number
productionLine	Production line
operationNo	Operation number
deviceNo	Device number
userName	User name

Notes:

• Part of the nav24/session group

Codes API

Scrap Code API (scrapCode)

Provides access to scrap codes.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/scrapCodeEntries ReadOnly

Operations:

• GET - Get scrap codes

Field	Description
systemId	System ID
code	Code
description	Description

Stop Code API (stopCode)

Provides access to stop codes.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/stopCodeEntries ReadOnly

Operations:

• GET - Get stop codes

Field	Description
systemId	System ID
code	Code
description	Description

Inventory API

Inventory API (inventory)

Provides inventory information.

Endpoint: /api/nav24/inventoryApi/v1.0/companies({companyID})/inventoryEntries ReadOnly

Operations:

• GET - Get inventory entries

Field	Description
itemNo	Item number
description	Description
inventoryPostingGroup	Inventory posting group
variantCode	Variant code
locationCode	Location code
binCode	Bin code
zoneCode	Zone code
lotNo	Lot number
serialNo	Serial number
unitOfMeasure	Unit of measure
qtyBase	Base quantity
qtyConsumptionEntry	Consumption entry quantity

Notes:

• Only available when bins are handled
• Contains information about unposted quantities from consumption entries and ShopFloor production entries

Bin API (bins)

Provides bin information.

Endpoint: /api/nav24/baseModuleAPI/v1.0/companies({companyID})/bins ReadOnly

Operations:

• GET - Get bins

Field	Description
code	Code
description	Description
systemCreatedAt	System created at
systemCreatedBy	System created by
id	System ID

Item Substitute API (itemSubstitute)

Provides item substitute information.

Endpoint: /api/nav24/inventoryApi/v1.0/companies({companyID})/itemSubstituteEntries ReadOnly

Operations:

• GET - Get item substitutes

Field	Description
variantCode	Variant code
substituteVariantCode	Substitute variant code
type	Type
substituteType	Substitute type
no	Number
substituteNo	Substitute number
description	Description
systemId	System ID

Employee API

Production Employee API (employee)

Provides access to production employees.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/employeeEntries ReadOnly

Operations:

• GET - Get production employees

Field	Description
no	Number
searchName	Search name
firstName	First name
lastName	Last name
companyEmail	Company email
productionEmployee	Production employee flag
capacityType	Capacity type
capacityNo	Capacity number
systemId	System ID
n24QRCode	QR code
n24PIN	PIN
n24Supervisor	Supervisor flag
n24SupervisorEmail	Supervisor email

Notes:

• List filtered to production employees (productionEmployee = true)

All Employee API (allEmployee)

Provides access to all employees (unfiltered).

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/allEmployeeEntries ReadOnly

Operations:

• GET - Get all employees

Field	Description
no	Number
searchName	Search name
firstName	First name
lastName	Last name
companyEmail	Company email
productionEmployee	Production employee flag
capacityType	Capacity type
capacityNo	Capacity number
systemId	System ID
n24QRCode	QR code
n24PIN	PIN
n24Supervisor	Supervisor flag
n24SupervisorEmail	Supervisor email

Company API

Company Information API (companyInformation)

Provides company information.

Endpoint: /api/nav24/baseModuleAPI/v1.0/companies({companyID})/companyInformations ReadOnly

Operations:

• GET - Get company information

Field	Description
systemId	System ID
picture	Picture
name	Name
name2	Name 2
address	Address
address2	Address 2
city	City
postCode	Post code
countryRegionCode	Country/region code
phoneNo	Phone number
phoneNo2	Phone number 2
vatRegistrationNo	VAT registration number
registrationNo	Registration number

Translation API (translations)

Provides access to translations.

Endpoint: /api/nav24/baseModuleAPI/v1.0/companies({companyID})/translations ReadWrite

Operations:

• GET - Get translations

Field	Description
systemId	System ID
language	Language
key	Key
value	Value

Notes:

• Part of the nav24/baseModuleAPI group

Production Capacity API

Production Order Line API (prodOrderLine)

Provides access to production order lines.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderLines ReadOnly

Operations:

• GET - Get production order lines

Field	Description
status	Production order status
orderNo	Production order number
lineNo	Line number
itemNo	Item number
variantCode	Variant code
itemDescription	Item description
quantity	Quantity
unitOfMeasure	Unit of measure code
inventoryPostingGroup	Inventory posting group
dueDate	Due date
locationCode	Location code
binCode	Bin code
finishedQuantity	Finished quantity
startingDateTime	Starting date and time
endingDateTime	Ending date and time
productionBOMNo	Production BOM number
productionBOMVersionCode	Production BOM version code
routingReferenceNo	Routing reference number
lotRequired	Lot tracking required
serialRequired	Serial tracking required
netWeight	Item net weight
grossWeight	Item gross weight
unitsPerParcel	Units per parcel
n24Comment	Comment
n24ProductionPriorityCode	Production priority code
n24ProductionPriorityColor	Production priority color
skipInProdPanel	Skip in ShopFloor flag
prodOrderDescription2	Production order description 2

Notes:

• API contains extended information from item card such as net weight and gross weight
• Contains lot/serial tracking requirements
• ShopFloor by default filters entries marked with skipInProdPanel = true

Production Order Routing Line API (prodOrderRoutingLine)

Provides access to production order routing lines.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderRoutingLines ReadOnly

Operations:

• GET - Get production order routing lines

Field	Description
status	Status
prodOrderNo	Production order number
routingReferenceNo	Routing reference number
routingNo	Routing number
routingLinkCode	Routing link code
routingStatus	Routing status
operationNo	Operation number
previousOperationNo	Previous operation number
nextOperationNo	Next operation number
type	Type
no	Number
description	Description
setupTime	Setup time
runTime	Run time
waitTime	Wait time
startingDateTime	Starting date and time
endingDateTime	Ending date and time
locationCode	Location code
toProductionBinCode	To-Production bin code
fromProductionBinCode	From-Production bin code
n24RegisteredUnitTime	Registered unit time
n24RegisteredQuantity	Registered quantity
n24ToleranceControlMethod	Tolerance control method
n24TolerancePercentage	Tolerance percentage
skipInProdPanel	Skip in ShopFloor flag

Grouped Production Order Lines API (prodOrderLinesGroup)

Groups production order lines with routing information.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderLinesGroups ReadOnly

Operations:

• GET - Get grouped production order lines

Field	Description
status	Status
prodOrderNo	Production order number
routingReferenceNo	Routing reference number
operationNo	Operation number
no	Number
description	Description
startingDateTime	Starting date and time
skipInProdPanel	Skip in ShopFloor flag
prodOrderLine_itemNo	Item number from production order line
prodOrderLine_description	Description from production order line
prodOrderLine_skipInProdPanel	Skip in ShopFloor flag from production order line
prodOrderLine_productionPriorityCode	Production priority code
productionOrder_description2	Production order description 2

Production Order Comment Line API (prodOrderCommentLine)

Provides access to production order comments.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderCommentLines ReadOnly

Operations:

• GET - Get production order comments

Field	Description
code	Code
comment	Comment text
date	Date
lineNo	Line number
prodOrderNo	Production order number
status	Status
systemId	System ID

Production Order Routing Comment Line API (prodOrderRtngCommentLine)

Provides access to routing comments for production orders.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderRtngCommentLines ReadOnly

Operations:

• GET - Get production order routing comments

Field	Description
status	Status
prodOrderNo	Production order number
routingReferenceNo	Routing reference number
routingNo	Routing number
operationNo	Operation number
lineNo	Line number
code	Code
comment	Comment
date	Date

Production Order Routing Tool API (prodOrderRoutingTool)

Provides access to tools required for production orders.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderRoutingTools ReadOnly

Operations:

• GET - Get production order routing tools

Field	Description
status	Status
prodOrderNo	Production order number
routingReferenceNo	Routing reference number
routingNo	Routing number
operationNo	Operation number
lineNo	Line number
no	Number
description	Description

Production Order Routing Personnel API (prodOrderRoutingPersonnel)

Provides access to personnel required for production orders.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderRoutingPersonnels ReadOnly

Operations:

• GET - Get production order routing personnel

Field	Description
status	Status
prodOrderNo	Production order number
routingReferenceNo	Routing reference number
routingNo	Routing number
operationNo	Operation number
lineNo	Line number
no	Number
description	Description

Quantity from Capacity Ledger Entry API (quantityFromCapacityLedgerEntry)

Provides output quantities from capacity ledger entries.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/quantityFromCapacityLedgerEntries ReadOnly

Operations:

• GET - Get quantities from capacity ledger entries

Field	Description
orderType	Order type
orderNo	Order number
orderLineNo	Order line number
routingNo	Routing number
routingReferenceNo	Routing reference number
operationNo	Operation number
quantity	Quantity (sum)
outputQuantity	Output quantity (sum)

Production Order Capacity Need API (prodOrderCapacityNeed)

Provides access to production order capacity needs.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderCapacityNeeds ReadOnly

Operations:

• GET - Get production order capacity needs

Field	Description
status	Status
prodOrderNo	Production order number
routingNo	Routing number
lineNo	Line number
operationNo	Operation number
type	Type
no	Number
workCenterNo	Work center number
workCenterGroupCode	Work center group code
routingReferenceNo	Routing reference number
date	Date
startingTime	Starting time
endingTime	Ending time
allocatedTime	Allocated time
sendAheadType	Send-ahead type
timeType	Time type
neededTime	Needed time
neededTimeMs	Needed time in milliseconds
lotSize	Lot size
concurrentCapacities	Concurrent capacities
efficiency	Efficiency
startingDateTime	Starting date and time
endingDateTime	Ending date and time
worksheetTemplateName	Worksheet template name
worksheetBatchName	Worksheet batch name
worksheetLineNo	Worksheet line number
active	Active flag
requestedOnly	Requested only flag

Production Order Routing Quality Measure API (prodOrderRtngQltyMeasure)

Provides access to quality measurements for production orders.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodOrderRtngQltyMeasures ReadOnly

Operations:

• GET - Get quality measures

Field	Description
routingNo	Routing number
lineNo	Line number
qltyMeasureCode	Quality measure code
description	Description
minValue	Minimum value
maxValue	Maximum value
meanTolerance	Mean tolerance
operationNo	Operation number
status	Status
prodOrderNo	Production order number
routingReferenceNo	Routing reference number

Work Centers API

Work Center API (workCenter)

Provides access to work centers.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/workCenterEntries ReadOnly

Operations:

• GET - Get work centers

Field	Description
no	Number
name	Name
name2	Name 2
blocked	Blocked flag
n24StationMode	Station mode
n24MultiUserSupport	Multi-user support flag
workCenterGroupCode	Work center group code
systemId	System ID

Machine Center API (machineCenter)

Provides access to machine centers.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/machineCenterEntries ReadOnly

Operations:

• GET - Get machine centers

Field	Description
no	Number
name	Name
workCenterNo	Work center number
blocked	Blocked flag
n24StationMode	Station mode
n24MultiUserSupport	Multi-user support flag
systemId	System ID

Work Center Group API (workCenterGroup)

Provides access to work center groups.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/workCenterGroupEntries ReadOnly

Operations:

• GET - Get work center groups

Field	Description
code	Code
name	Name

Production Line Employee API (prodLineEmployee)

Provides access to employees/devices assigned to production lines.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/productionLineNoEmployeeEntries ReadOnly

Operations:

• GET - Get production line employee assignments

Field	Description
device	Device
deviceName	Device name
deviceMail	Device email
type	Type
productionLineNo	Production line number
systemId	System ID

Work Shift API (workShift)

Provides access to work shifts.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/workShifts ReadOnly

Operations:

• GET - Get work shifts

Field	Description
code	Code
description	Description

Production BOM API

Production BOM Line API (prodBOMLineEntry)

Provides access to production BOM lines.

Endpoint: /api/nav24/prodOrderApi/v1.0/companies({companyID})/prodBOMLineEntries ReadOnly

Operations:

• GET - Get production BOM lines

Field	Description
productionBOMNo	Production BOM number
versionCode	Version code
activeVersion	Active version
lineNo	Line number
type	Type
no	Number
unitOfMeasureCode	Unit of measure code
variantCode	Variant code
description	Description
quantity	Quantity
quantityPer	Quantity per
length	Length
depth	Depth
weight	Weight
width	Width
systemId	System ID
startingDate	Starting date
endingDate	Ending date
routingLinkCode	Routing link code
inventoryPostingGroup	Inventory posting group

Inventory API

Item Details API (itemEntry)

Provides detailed item information.

Endpoint: /api/nav24/itemApi/v1.0/companies({companyID})/itemEntries ReadOnly

Operations:

• GET - Get item details

Field	Description
no	Number
no2	Number 2
description	Description
description2	Description 2
searchDescription	Search description
baseUnitOfMeasure	Base unit of measure
gtin	GTIN
netWeight	Net weight
grossWeight	Gross weight
unitsPerParcel	Units per parcel
productionBOMNo	Production BOM number
routingNo	Routing number

Item Unit of Measure API (itemUnitOfMeasureEntry)

Provides item unit of measure information.

Endpoint: /api/nav24/itemApi/v1.0/companies({companyID})/itemUnitOfMeasureEntries ReadOnly

Operations:

• GET - Get item units of measure

Field	Description
itemNo	Item number
code	Code
qtyPerUnitOfMeasure	Quantity per unit of measure
systemId	System ID

Items with Attributes API (itemsWithAttributesEntry)

Provides item information with attributes.

Endpoint: /api/nav24/itemApi/v1.0/companies({companyID})/itemsWithAttributesEntries ReadOnly

Operations:

• GET - Get items with attributes

Field	Description
no	Number
description	Description
tableID	Table ID
itemAttributeID	Item attribute ID
itemAttributeValueID	Item attribute value ID
name	Name
type	Type
unitofMeasure	Unit of measure
value	Value
numericValue	Numeric value
dateValue	Date value
blocked	Blocked flag