Mintsoft · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Return API
11 actions
11 updates
phrasing
extends
openapi/mintsoft-return-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Mintsoft's API. It is a proposal applied on top of the contract, not a document Mintsoft publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/api/Return/Reasons'].get
$.paths['/api/Return/{id}'].get
$.paths['/api/Return/{id}/Items'].get
$.paths['/api/Return/SearchByDate'].get
$.paths['/api/Return/CreateReturn/{OrderId}'].post
$.paths['/api/Return/CreateExternalReturn'].post
$.paths['/api/Return/{id}/AddItem'].post
$.paths['/api/Return/{id}/AllocateItemLocation'].post
$.paths['/api/Return/{id}/Confirm'].post
$.paths['/api/Return/List'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Return API
version: 1.0.0
extends: openapi/mintsoft-return-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-11-20'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 10
- target: $.paths['/api/Return/Reasons'].get
update:
x-apievangelist-phrasing:
intent: List return reasons
effect: read
questions:
- What reasons can a customer give for returning an item?
- Which return reasons are available for returns?
instructions:
- text: List the available return reasons.
- text: Show me the return reason codes and descriptions.
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a return
effect: read
questions:
- What is the status of a specific return?
- Can I look up one return by its ID?
instructions:
- text: Get return {id}.
slots:
id: path.id
- text: Show the details of return {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/{id}/Items'].get
update:
x-apievangelist-phrasing:
intent: List items on a return
effect: read
questions:
- Which items are included in a return?
- Can I see the line items on a return?
instructions:
- text: List the items on return {id}.
slots:
id: path.id
- text: Show what is being returned in return {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/SearchByDate'].get
update:
x-apievangelist-phrasing:
intent: List returns updated on a date
effect: read
questions:
- Which returns were last updated on a given day?
- Can I find returns changed on a specific date?
instructions:
- text: List returns last updated on {Date}.
slots:
Date: query.Date
- text: Find returns changed since {Date}.
slots:
Date: query.Date
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/CreateReturn/{OrderId}'].post
update:
x-apievangelist-phrasing:
intent: Create a return for an order
effect: write
questions:
- How do I start a return for an order?
- Can I create a return for an order in a specific warehouse?
instructions:
- text: Create a return for order {OrderId}.
slots:
OrderId: path.OrderId
- text: Start a return for order {OrderId} in warehouse {WarehouseId}.
slots:
OrderId: path.OrderId
WarehouseId: query.WarehouseId
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/CreateExternalReturn'].post
update:
x-apievangelist-phrasing:
intent: Create an external return
effect: write
questions:
- Can I create a return not linked to any order?
- How do I record a return from a customer who never ordered?
instructions:
- text: Create an external return for client {ClientId} with items {ReturnItems}.
slots:
ClientId: requestBody.ClientId
ReturnItems: requestBody.ReturnItems
- text: Record a standalone return {Reference} for warehouse {WarehouseId}.
slots:
Reference: requestBody.Reference
WarehouseId: requestBody.WarehouseId
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/{id}/AddItem'].post
update:
x-apievangelist-phrasing:
intent: Add an item to a return
effect: write
questions:
- How do I add a product to an existing return?
- Can I record a return reason and photos for an item on a return?
instructions:
- text: Add product {ProductId} to return {id}.
slots:
ProductId: requestBody.ProductId
id: path.id
- text: Add {Quantity} of item {ProductId} to return {id} with reason {ReturnReasonId}.
slots:
Quantity: requestBody.Quantity
ProductId: requestBody.ProductId
id: path.id
ReturnReasonId: requestBody.ReturnReasonId
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/{id}/AllocateItemLocation'].post
update:
x-apievangelist-phrasing:
intent: Allocate a return item to a location
effect: write
questions:
- How do I assign a returned item to a warehouse location?
- Can I allocate a quantity of a return item to a location?
instructions:
- text: Allocate {Quantity} of return item {ReturnitemId} on return {id} to location {LocationId}.
slots:
Quantity: query.Quantity
ReturnitemId: query.ReturnitemId
id: path.id
LocationId: query.LocationId
- text: Put {Quantity} of item {ReturnitemId} from return {id} into location {LocationId}.
slots:
Quantity: query.Quantity
ReturnitemId: query.ReturnitemId
id: path.id
LocationId: query.LocationId
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/{id}/Confirm'].post
update:
x-apievangelist-phrasing:
intent: Confirm a return
effect: write
questions:
- How do I confirm a return so it can be processed?
- Can I confirm a return after adding items?
instructions:
- text: Confirm return {id}.
slots:
id: path.id
- text: Mark return {id} as confirmed.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Return/List'].get
update:
x-apievangelist-phrasing:
intent: List returns
effect: read
questions:
- Which returns exist across my clients or warehouses?
- Can I list only confirmed returns or external returns?
instructions:
- text: List all returns.
- text: List returns for client {ClientId} in warehouse {WarehouseId}.
slots:
ClientId: query.ClientId
WarehouseId: query.WarehouseId
- text: List returns updated since {SinceLastUpdated}.
slots:
SinceLastUpdated: query.SinceLastUpdated
- text: Show {Limit} returns per page for client {ClientId}.
slots:
Limit: query.Limit
ClientId: query.ClientId
method: generated
generated: '2026-11-20'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/mintsoft-return-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.