Anexya Active Retail backend inbound API
Browse all Swaggerhub Anexya APIs★ Only Publicly Available OpenAPI DocumentDeveloper ToolsSource Controlnone41 Endpoints
For Agents
Programmatically get an authentication token, revoke an authentication token. Covers 41 operations.
Use for: I need to an authentication token, I want to revoke an authentication token, Search for location by name, Find all location by name
Not supported: Does not handle payments, communications, or crm - use for developer tools only.
This is the Active Retail backend inbound API integration documentation. The API exposes 41 endpoints.
Install Jentic One Beta
Connect the Active Retail backend inbound API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Active Retail backend inbound API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fswaggerhub.anexya%2Factive-retail-backend-inbound-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fswaggerhub.anexya%2Factive-retail-backend-inbound-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Active Retail backend inbound API.
Get an authentication token
Revoke an authentication token
Delete location by name
Create or update existing locations
Monitor Active Retail backend inbound API operational status and events
Use Cases
Patterns agents use Active Retail backend inbound API for, with concrete tasks.
★ Developer Tools Operations
Use the Active Retail backend inbound API to perform developer tools operations programmatically. The API provides 41 endpoints covering core functionality including get an authentication token, revoke an authentication token, get location by name.
Call POST /rest/v2/oauth/token to get an authentication token
Automated OAuth Management
Automate oauth operations by combining multiple Active Retail backend inbound API endpoints. Agents can revoke an authentication token and then get location by name in a single workflow.
Call POST /rest/v2/oauth/revoke to revoke an authentication token, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Active Retail backend inbound API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.
Search Jentic for 'get an authentication token', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
41 endpoints — this is the active retail backend inbound api integration documentation.
METHOD
PATH
DESCRIPTION
POST
/rest/v2/oauth/token
Get an authentication token
POST
/rest/v2/oauth/revoke
Revoke an authentication token
GET
/rest/api/v2/locations/{name}
Get location by name
DELETE
/rest/api/v2/locations/{name}
Delete location by name
GET
/rest/api/v2/locations/{name}/items
Get items count within a location
POST
/rest/api/v2/locations
Create or update existing locations
GET
/rest/api/v2/locations
Get all locations
POST
/rest/api/v2/locations/items
Create or update existing locations with their items
POST
/rest/v2/oauth/token
Get an authentication token
POST
/rest/v2/oauth/revoke
Revoke an authentication token
GET
/rest/api/v2/locations/{name}
Get location by name
DELETE
/rest/api/v2/locations/{name}
Delete location by name
GET
/rest/api/v2/locations/{name}/items
Get items count within a location
POST
/rest/api/v2/locations
Create or update existing locations
GET
/rest/api/v2/locations
Get all locations
POST
/rest/api/v2/locations/items
Create or update existing locations with their items
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Active Retail backend inbound API by hand means walking its OAuth token and revoke endpoints, tracking the location resource paths, and handling create, read, and delete calls yourself. Through Jentic you install once, import the Active Retail backend inbound API from the API Directory, store the token once, and your agent calls it.
Permission scoping
This API puts the location name in the URL path (/rest/api/v2/locations/{name}/...), so a rule can pin your agent to one location: it can read that location and its items and nothing else. You choose the operations it may call, so destructive ones like deleting a location are not included unless you add them.
Credential isolation
Your Active Retail token 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.
Intent-based discovery
Agents search Jentic by intent such as 'list items at a retail location' or 'get an authentication token', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Github
Alternative developer tools API
Choose Github when you need a different approach to developer tools operations
FAQs
Specific to using Active Retail backend inbound API through Jentic.
What authentication does the Active Retail backend inbound API use?
The Active Retail backend inbound API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I get an authentication token with the Active Retail backend inbound API?
Yes. Use the POST /rest/v2/oauth/token endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Active Retail backend inbound API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I get an authentication token through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get an authentication token'. Jentic returns the matching Active Retail backend inbound API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Active Retail backend inbound API have?
The Active Retail backend inbound API exposes 41 endpoints covering oauth operations.
Can I limit what my agent is allowed to do with the Active Retail backend inbound API?
Yes. Because you run Jentic One yourself, your own rules decide which of this API's operations and credentials the agent may use. Since the location name sits in the URL path (/rest/api/v2/locations/{name}/...), you can pin the agent to a single location so it only reads that location and its item counts and touches nothing else. You choose the operations it may call, so destructive ones like deleting a location or creating and updating locations stay out of reach unless you add them.
GET STARTED