# Simple RFID API (v3)

## Overview

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

## ****Authentication****

### API Key Authentication (Recommended for Server-to-Server)

****How to generate the key and where to enter it:****

<span style="white-space: pre-wrap;">1. </span>****Go to****<span style="white-space: pre-wrap;"> </span>[Simple RFID website](https://portal.simplerfid.com/)  
<span style="white-space: pre-wrap;">2. </span>****Click****<span style="white-space: pre-wrap;"> on the top-right to expand User Menu</span>  
<span style="white-space: pre-wrap;">3. </span>****Select**** **"Customer Profile"**  
<span style="white-space: pre-wrap;">4. In the </span>**API Tokens**<span style="white-space: pre-wrap;"> section, </span>****click**** *"+ Create Token"**  
<span style="white-space: pre-wrap;">5. (optional) </span>****Set**** the token's name  
<span style="white-space: pre-wrap;">6. </span>****Click**** Create  
<span style="white-space: pre-wrap;">7. </span>****Copy**** <span style="white-space: pre-wrap;">the token as </span>*****you will never see it again*****  
<span style="white-space: pre-wrap;">8. </span>****Open****<span style="white-space: pre-wrap;"> </span>[Simple RFID API from Web](https://qa-api.simplerfid.com/scalar/#simplerfid-api-v1/description/introduction)<span style="white-space: pre-wrap;"> (or from your REST client)</span>  
<span style="white-space: pre-wrap;">9. </span>****Select**** <span style="white-space: pre-wrap;">your authentication method as </span>`<span class="editor-theme-code">apiKey</span>`  
<span style="white-space: pre-wrap;">10. </span>****Include**** your API key in the request header:

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

---

## ****Key Endpoints****

### Layouts

- `<span class="editor-theme-code">GET /v3/printing/layout</span>`<span style="white-space: pre-wrap;"> - List label layouts (filter by Dpi, Keyword, FormatTypes; sort and paginate)</span>
- `<span class="editor-theme-code">GET /v3/printing/layout/{id}</span>`<span style="white-space: pre-wrap;"> - Get specific layout</span>

### Locations

- `<span class="editor-theme-code">GET /v3/locations</span>`<span style="white-space: pre-wrap;"> - List locations (filter by LocationKeys; sort by Name, Type, etc.; paginate)</span>

### Orders

- `<span class="editor-theme-code">GET /v3/orders</span>`<span style="white-space: pre-wrap;"> - List orders (filter by type, status, locations; sort by CreateDate, Status; paginate)</span>
- `<span class="editor-theme-code">POST /v3/orders</span>`<span style="white-space: pre-wrap;"> - Create order (Purchase, Sales, or Transfer)</span>
- `<span class="editor-theme-code">GET /v3/orders/{id}</span>`<span style="white-space: pre-wrap;"> - Get order details with items</span>

### Printers &amp; Print Jobs

- `<span class="editor-theme-code">GET /v3/stations/printers</span>`<span style="white-space: pre-wrap;"> - List all printers</span>
- `<span class="editor-theme-code">POST /v3/printers/{serialNumber}/jobs</span>`<span style="white-space: pre-wrap;"> - Submit print job (returns UUID)</span>
- `<span class="editor-theme-code">GET /v3/printers/{serialNumber}/jobs</span>`<span style="white-space: pre-wrap;"> - Get print job history (filter by status, dates; paginate)</span>

### Products

- `<span class="editor-theme-code">GET /v3/products/search</span>`<span style="white-space: pre-wrap;"> - Search products (filter by SKU, keyword; sort by UpdateDate; paginate)</span>
- `<span class="editor-theme-code">POST /v3/products</span>`<span style="white-space: pre-wrap;"> - Bulk import products (GS1 identifiers, attributes, pricing, references)</span>

### Inventory

- `<span class="editor-theme-code">GET /v3/inventory</span>`<span style="white-space: pre-wrap;"> - Query inventory (filter by status, expiration, location, age; paginate)</span>

---

## Common Patterns

- ****Pagination****<span style="white-space: pre-wrap;">: Use </span>`<span class="editor-theme-code">Offset</span>`<span style="white-space: pre-wrap;"> and </span>`<span class="editor-theme-code">Take</span>`<span style="white-space: pre-wrap;"> parameters</span>
- ****Sorting****<span style="white-space: pre-wrap;">: Use </span>`<span class="editor-theme-code">OrderBy</span>`<span style="white-space: pre-wrap;"> and </span>`<span class="editor-theme-code">OrderDirection</span>`<span style="white-space: pre-wrap;"> (Ascending/Descending)</span>
- ****Date Format****<span style="white-space: pre-wrap;">: ISO 8601 - </span>`<span class="editor-theme-code">YYYY-MM-DDTHH:MM:SS.sssZ</span>`
- ****Filtering****<span style="white-space: pre-wrap;">: Parameter-specific arrays (e.g., </span>`<span class="editor-theme-code">OrderStatuses=Shipping&OrderStatuses=ShippingQC</span>`)

---

## ****Support****

For technical support, API access requests, or questions:

- ****Documentation:****<span style="white-space: pre-wrap;"> Refer to this API reference</span>
- ****Questions or Technical Issues:****<span style="white-space: pre-wrap;"> Report through your organization's support channel or </span>[submit a ticket](https://support.simplerfid.com/support/tickets/new)<span style="white-space: pre-wrap;"> to reach our support team.</span>