canonical: https://jentic.com/apis/rightgun.uk/rightgun

# Rightgun.uk - OpenAPI 3.1.0

The Rightgun.uk integration API syncs a UK firearms dealer's Armoury stock with the Rightgun.uk portal. It adds and updates Armoury items, reads and sets stock levels by SKU or reference, changes item status, and advertises an item either at a fixed price with retail, sale, and trade tiers or as an auction with a reserve, duration, and increment. When an item sells, one call records the sale date, sale and purchase price, and the other party, ends the advert, and marks the item Sold. Metadata endpoints look up calibres for rifles, shotguns, and airguns and manage the category, sub category, and further category tree.

## For AI agents

Keep a dealer's Rightgun.uk Armoury in sync: add items, update stock by SKU or reference, advertise at a fixed price or by auction, record sales, and look up calibres and categories.

## Scope

Does not take payments, ship items, or verify licences or certificates. Use for syncing a dealer's Armoury items, stock, adverts, and sale records with Rightgun.uk only.

## Capabilities

- Add Armoury items and update them by reference, with your own system's id mapped via xReference
- Read and set stock quantity, status, and restock details by SKU or by item reference
- Advertise an item at a fixed price with perUnit, perUnitSale, and perUnitTrade tiers, or with price on application
- List an item as an auction with reserve, starting, increment, duration, and buy-now values
- Record a sale with date, priceSell, pricePurchase, and party, which ends the advert and marks the item Sold
- Look up calibres by type, such as Rifle, Shotgun, or Airgun, with fuzzy matching
- Browse and extend the category, sub category, and further category tree

## Use cases

### Agent-run stock sync with bounded write access

A dealer's developer wants an agent to keep Rightgun.uk stock in line with their shop system, without giving it the power to sell or re-price items. Through Jentic the agent searches by intent, gets the updateItemStockByReference operation with its input schema, and calls it with the OAuth token injected at execution time. Because every item operation carries the reference or SKU in the URL path, the developer's rule can allow stock updates while leaving advertise and sell out.

Example prompt: For each changed row in the shop export, call PUT `/item/inventory/reference/{reference}` with the new quantity and status, then confirm with GET `/item/inventory/reference/{reference}`

### Advertising stock at fixed price or auction

Dealers choose per item whether to sell at a set price or by auction. POST `/item/advertise/{reference}` takes a type of fixed or auction plus price tiers such as perUnit, perUnitSale, per10Unit, and perUnitTrade, with taxInclusive and priceOnApplication flags. POST `/item/advertise/auction/{reference}` sets reserve, starting, increment, duration, and buy values and places the auction advert.

Example prompt: Call POST `/item/advertise/{reference}` for item 'REF-1029' with type 'fixed', perUnit 85000, perUnitTrade 78000, and taxInclusive true

### Recording a completed sale

When an item leaves the shop, the dealer's records and the advert both need to change. POST `/item/sell/{reference}` accepts the sale date, priceSell, pricePurchase, the party to the sale, notes, and the sendConfirmation and sendNoticeOfTransfer flags. Rightgun.uk then ends the advertisement and sets the item status to Sold.

Example prompt: Call POST `/item/sell/{reference}` for 'REF-1029' with date '2026-11-18', priceSell 85000, pricePurchase 60000, the buyer as party, and sendConfirmation true, then check GET `/item/status/reference/{reference}`

### Classifying new stock with calibre and categories

New items need the right calibre and category before they are advertised. GET `/metadata/calibre` searches calibres with a type of Rifle, Shotgun, or Airgun and a match mode of Fuzzy or Numbers only, while GET `/metadata/category`, GET `/metadata/subCategory/{category}`, and GET `/metadata/furtherCategory/{subCategory}` walk the category tree. Missing entries can be added with the matching POST operations.

Example prompt: Call GET `/metadata/calibre` with calibre '12', type 'Shotgun', and match 'Numbers only', then list sub categories via GET `/metadata/subCategory/{category}` for the chosen category

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/item` | Add a new item to the Armoury |
| GET | `/items` | Get all items |
| PUT | `/item/inventory/reference/{reference}` | Update stock levels by reference |
| POST | `/item/advertise/{reference}` | Advertise an item with a price |
| POST | `/item/advertise/auction/{reference}` | Advertise an item as an auction |
| POST | `/item/sell/{reference}` | Record the sale of an item |
| GET | `/metadata/calibre` | Look up a calibre |

## Key resources

- **Items** — Add, read, and update Armoury items by id or reference, list all items, and map external references
- **Inventory and status** — Read and update stock levels by SKU or reference, and read or change item status
- **Adverts and sales** — Advertise an item at a fixed price or as an auction, and record a sale
- **Metadata** — Calibres by firearm type, and the category, sub category, and further category tree

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 72 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 85 / 100
  - AI Discoverability: 64 / 100
- **View full report:** https://jentic.com/apis/rightgun.uk/rightgun/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Rightgun.uk by hand means running its OAuth client credentials flow against the portal token endpoint, requesting read_items and write_items, and keeping item references in step with your own system. Through Jentic you install once, import Rightgun.uk from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Rightgun.uk puts the item reference, id, or SKU in the URL path, as in `/item/sell/{reference}`, so a rule can pin your agent to the item operations and paths it needs. You choose the operations it may call, so ones like recording a sale or advertising an item are not included unless you add them.
- **Credential handling:** Your Rightgun.uk client credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'update stock for an item' or 'advertise an item at auction', and Jentic returns the matching Rightgun.uk operation with its input schema so the agent sends the right reference and fields.

## Related APIs

- **Square API** — General retail point of sale with item libraries and inventory counts
- **Shopify API** — General online store platform with products, inventory, and orders
- **Xero Accounting API** — Invoices and ledgers for booking the sales a dealer records

## FAQ

### What authentication does the Rightgun.uk API use?

Per its OpenAPI spec, the Rightgun.uk API uses OAuth 2.0 with the client credentials flow, under the scheme oAuthRightgun, with the scopes read_items and write_items. You exchange your client id and secret at the portal's OAuth token endpoint for an access token. Through Jentic the credential is held by your own Jentic One instance and the token is attached at call time.

### Can I update stock by my own SKU with the Rightgun.uk API?

Yes. PUT `/item/inventory/{sku}` updates stock for an item by stock number or id, and PUT `/item/inventory/reference/{reference}` does the same by item reference. Both accept quantity, status, restock, weight, weightUnit, and dimensions. New items start with a stock level of 1 and a status of In stock.

### What are the rate limits for the Rightgun.uk API?

The OpenAPI spec does not specify rate limits. Contact Rightgun.uk support through https://www.rightgun.uk/contact-us for current limits before running a full Armoury sync.

### Is there a Rightgun.uk MCP server?

You don't need an MCP server to give your agent Rightgun.uk. Jentic connects it directly from the API Directory: import it, store your OAuth client credential once, and your agent calls the stock, advert, and sale operations on demand without another server's tool definitions in its context.

### How do I update an item's stock through Jentic?

Search Jentic for 'update Rightgun item stock', load the updateItemStockByReference operation, and execute PUT `/item/inventory/reference/{reference}` with the item reference and new quantity. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the Rightgun.uk API?

Yes. For a stock-sync agent, write a rule that allows only GET and PUT on `/item/inventory/reference/{reference}.` It can read and set stock levels but cannot advertise, re-price, or record a sale, and every call it makes is logged.
