Skip to main content

Integration API Overview

Nord Inventory exposes a Nord-native API with familiar slot-inventory contracts so other FiveM resources need minimal inventory-specific code.

Server vs client

Use server exports for anything that changes inventory state or requires trusted access checks.

Use client exports only for read-only access to the local player's lightweight inventory snapshot.

Inventory identifiers

Server exports accept several target forms:

  • Player server ID (source) as a number.
  • Registered inventory ID such as mechanic_storage.
  • Full Nord keys such as:
    • stash:police_armory
    • trunk:ABC123
    • glovebox:ABC123
  • In some internal/integration cases, a resolved inventory object/table.

Metadata matching

Metadata can be a table or a primitive value. Primitive values are normalized to:

{ type = value }

Read/search helpers normally perform partial metadata matching. Helpers with a strict argument can require the complete metadata object to match exactly.

Do not expose unrestricted client events that directly mutate inventories. Validate permissions/business logic in your server resource, then call Nord server exports.

API size in v1.6.11

  • 52 server exports including the five vehicle-capacity helpers.
  • 11 client exports including the two OpenInventory aliases and nine read-only snapshot/search helpers.

Use server exports for all authoritative mutations. Client exports should be treated as convenience/read-only snapshot helpers except for requesting the inventory UI to open.

Back to top