Skip to main content

Loca.fi API Documentation

Loca.fi is Ramp's RFID inventory and asset tracking platform. The Loca.fi API is the HTTP surface that Ramp's own web applications, mobile apps, and integration partners use to read and write the data the platform manages, including:

  • Items — individual tracked items (assets or retail units), their state history, movement history, and tag assignments.
  • Places — the hierarchical locations and zones items move through (warehouses, stores, zones, shelves).
  • SKUs — the item-type/catalog definitions that items are instances of, including retail pricing and GS1 barcode identifiers.
  • Orders — inbound/outbound order workflows, including the SKU and unique-item line items and the scan records that fulfill them.
  • Stocktakes / snapshots — point-in-time RFID scan captures used to reconcile expected vs. actual inventory at a place.
  • Tasks — work items assigned to users, often driven by scan or order activity.
  • Service records — maintenance/service history for tracked assets.
  • Fixed RFID infrastructure — configuration and status for permanently-installed RFID readers and antennas (as opposed to handheld scanning).

Authentication​

The API uses a custom JWT scheme. Every authenticated request must send:

Authorization: Token <jwt>

Note the scheme name is Token, not the more common Bearer — sending Authorization: Bearer <jwt> will get you a 401 Unauthorized.

You obtain a token by logging in:

POST /api/authentication/login
Content-Type: application/json

{ "Username": "...", "Password": "..." }

See the Getting Started guide for the full walkthrough, including the response shape, permission bitmasks, and how to use the resulting token on subsequent calls.

Tier model​

Operations and schemas in the API Reference are labelled with a tier badge in their description:

  • Tier: Public — stable, supported for external/partner integration. Breaking changes go through a deprecation process.
  • Tier: Internal — used internally by Ramp's own clients. Subject to change without notice; do not build external integrations against Internal-tier operations without checking with Ramp first.

Where to go next​

  • Guides — task-oriented walkthroughs (starting with authentication) that combine multiple endpoints to accomplish a real workflow.
  • Concepts — background on how core entities relate to each other and the state machines they move through.
  • API Reference — the complete, generated endpoint-by-endpoint reference, grouped by tag.