Skip to main content

Simple RFID API (v3)

Overview

The V3 API provides modern endpoints for managing RFID label printing, inventory, orders, products, and printer stations.

Authentication

The Simple RFID API supports two authentication methods:

Option 1: API Key Authentication (Recommended for Server-to-Server)

How to generate the key and where to enter it:

1. Go to Simple RFID website
2. Click on the top-right to expand User Menu
3. Select "Customer Profile"
4. In the API Tokens section, click "+ Create Token"
5. (optional) Set the token's name
6. Click Create
7. Copy the token as you will never see it again
8. Open Simple RFID API from Web (or from your REST client)
9. Select your authentication method as apiKey
10. Include your API key in the request header:

X-Api-Key: your-api-key-here

Option 2: OAuth 2.0 Authorization Code Flow

For user-delegated access, use OAuth 2.0 with the following endpoints:

  • Authorization URL: https://identity.simplerfid.com/connect/authorize
  • Token URL: https://identity.simplerfid.com/connect/token
  • Request URL: https://api.simplerfid.com/scalar/oauth2-redirect
  • Client ID: external.api.scalar.pkce
  • Use PKCE: no
  • Credentials Location: header

Required Scopes:

  • openid - OpenID authentication
  • profile - User profile access
  • externalapi - External API access

How to authorize:

1. Go to Simple RFID website
2. Enter your creadentials
3. Click Login
4. Open Simple RFID API from Web (or from your REST client)
5. Select your authentication method as oauth2
6. Click Authorize

Key Endpoints

Layouts

  • GET /v3/printing/layout - List label layouts (filter by Dpi, Keyword, FormatTypes; sort and paginate)
  • GET /v3/printing/layout/{id} - Get specific layout

Locations

  • GET /v3/locations - List locations (filter by LocationKeys; sort by Name, Type, etc.; paginate)

Orders

  • GET /v3/orders - List orders (filter by type, status, locations; sort by CreateDate, Status; paginate)
  • POST /v3/orders - Create order (Purchase, Sales, or Transfer)
  • GET /v3/orders/{id} - Get order details with items

Printers & Print Jobs

  • GET /v3/stations/printers - List all printers
  • POST /v3/printers/{serialNumber}/jobs - Submit print job (returns UUID)
  • GET /v3/printers/{serialNumber}/jobs - Get print job history (filter by status, dates; paginate)

Products

  • GET /v3/products/search - Search products (filter by SKU, keyword; sort by UpdateDate; paginate)
  • POST /v3/products - Bulk import products (GS1 identifiers, attributes, pricing, references)

Inventory

  • GET /v3/inventory - Query inventory (filter by status, expiration, location, age; paginate)

Common Patterns

  • Pagination: Use Offset and Take parameters
  • Sorting: Use OrderBy and OrderDirection (Ascending/Descending)
  • Date Format: ISO 8601 - YYYY-MM-DDTHH:MM:SS.sssZ
  • Filtering: Parameter-specific arrays (e.g., OrderStatuses=Shipping&OrderStatuses=ShippingQC)

Support

For technical support, API access requests, or questions:

  • Documentation: Refer to this API reference
  • Support Contact: Contact your Simple RFID account representative or contact support@simplerfid.com
  • Technical Issues: Report through your organization's support channel or contact support@simplerfid.com
Back to top