Mintsoft · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Product API
32 actions
32 updates
phrasing
extends
openapi/mintsoft-product-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 32 · first 16 shown; the file carries all of them
$.info
$.paths['/api/Product'].put
$.paths['/api/Product'].post
$.paths['/api/Product/{id}'].get
$.paths['/api/Product/{id}'].delete
$.paths['/api/Product/ProductPrices'].put
$.paths['/api/Product/ProductPrices'].delete
$.paths['/api/Product/List'].get
$.paths['/api/Product/Bundle'].put
$.paths['/api/Product/{id}/Bundle'].get
$.paths['/api/Product/{id}/StockFlow'].get
$.paths['/api/Product/{id}/Cartons'].get
$.paths['/api/Product/{id}/Cartons'].post
$.paths['/api/Product/{id}/Carton/{cartonId}'].delete
$.paths['/api/Product/{id}/AltCodes'].get
$.paths['/api/Product/{id}/AltCodes'].post
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 Product API
version: 1.0.0
extends: openapi/mintsoft-product-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: 31
- target: $.paths['/api/Product'].put
update:
x-apievangelist-phrasing:
intent: Create a product
effect: write
questions:
- How do I add a new product with its SKU and weight?
- Can I set packing instructions and low stock alert levels when creating a product?
instructions:
- text: Create product {SKU} weighing {Weight}.
slots:
SKU: requestBody.SKU
Weight: requestBody.Weight
- text: Add product {SKU} with name {Name}, weight {Weight} and packing instructions {PackingInstructions}.
slots:
SKU: requestBody.SKU
Name: requestBody.Name
Weight: requestBody.Weight
PackingInstructions: requestBody.PackingInstructions
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product'].post
update:
x-apievangelist-phrasing:
intent: Update a product
effect: write
questions:
- How do I change the price or cost of an existing product?
- Can I update a product's SKU and weight after it's created?
instructions:
- text: Update product {SKU} to price {Price} and cost {CostPrice}.
slots:
SKU: requestBody.SKU
Price: requestBody.Price
CostPrice: requestBody.CostPrice
- text: Change the weight of product {SKU} to {Weight}.
slots:
SKU: requestBody.SKU
Weight: requestBody.Weight
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a product's details
effect: read
questions:
- What are the details of a particular product?
- Can I see the components of a bundle product?
instructions:
- text: Get product {id}.
slots:
id: path.id
- text: Show the bundle and its items for product {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a product
effect: destructive
questions:
- How do I delete a product that is still in stock?
- Can a product be deleted if it is part of a bundle?
instructions:
- text: Delete product {id}.
slots:
id: path.id
- text: Remove product {id} from the catalog.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/ProductPrices'].put
update:
x-apievangelist-phrasing:
intent: Add or update product prices
effect: write
questions:
- How do I set the price for a product?
- Can I update several product prices in one request?
instructions:
- text: Add or update the prices for my products.
- text: Set the price of each product in my list.
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/ProductPrices'].delete
update:
x-apievangelist-phrasing:
intent: Delete product prices
effect: destructive
questions:
- How do I remove a price from a product?
- Can I delete product prices entirely?
instructions:
- text: Delete the product prices.
- text: Remove the price record from my products.
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/List'].get
update:
x-apievangelist-phrasing:
intent: List products
effect: read
questions:
- Which products do I have in stock?
- Can I list products updated since a certain date?
instructions:
- text: List my products.
- text: Show products updated since {SinceLastUpdated}.
slots:
SinceLastUpdated: query.SinceLastUpdated
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/Bundle'].put
update:
x-apievangelist-phrasing:
intent: Create a bundle
effect: write
questions:
- How do I create a bundle of products?
- Can a bundle have its own SKU and components?
instructions:
- text: Create bundle {Name} with components {Components}.
slots:
Name: requestBody.Name
Components: requestBody.Components
- text: Add a new bundle {Name} using SKU {SKU}.
slots:
Name: requestBody.Name
SKU: requestBody.SKU
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/Bundle'].get
update:
x-apievangelist-phrasing:
intent: Get a product bundle and its items
effect: read
questions:
- What does a product bundle contain and how many items are in it?
- Can I see the item details for a bundled product?
instructions:
- text: Get the bundle details and items for product {id}.
slots:
id: path.id
- text: Show me what is in bundle {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/StockFlow'].get
update:
x-apievangelist-phrasing:
intent: Get a product's stock flow
effect: read
questions:
- How has a product's stock moved over a date range?
- Can I see inbound and outbound stock flow for a product?
instructions:
- text: Get stock flow for product {id} from {FromDate} to {ToDate}.
slots:
id: path.id
FromDate: query.FromDate
ToDate: query.ToDate
- text: Show stock movements for product {id} between {FromDate} and {ToDate}, including details {IncludeDetails}.
slots:
id: path.id
FromDate: query.FromDate
ToDate: query.ToDate
IncludeDetails: query.IncludeDetails
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/Cartons'].get
update:
x-apievangelist-phrasing:
intent: Get a product's cartons
effect: read
questions:
- Which cartons are assigned to a product?
- Can I list the cartons of a product?
instructions:
- text: Get the cartons of product {id}.
slots:
id: path.id
- text: List cartons assigned to product {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/Cartons'].post
update:
x-apievangelist-phrasing:
intent: Add cartons to a product
effect: write
questions:
- How do I add many cartons to a product at once?
- Can I bulk add cartons against a product?
instructions:
- text: Bulk add cartons to product {id}.
slots:
id: path.id
- text: Add a batch of cartons against product {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/Carton/{cartonId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a carton from a product
effect: destructive
questions:
- How do I remove a single carton from a product?
- Can I delete one carton by its ID?
instructions:
- text: Delete carton {cartonId} from product {id}.
slots:
cartonId: path.cartonId
id: path.id
- text: Remove carton {cartonId} on product {id}.
slots:
cartonId: path.cartonId
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/AltCodes'].get
update:
x-apievangelist-phrasing:
intent: Get a product's alternative codes
effect: read
questions:
- What alternative SKUs are mapped to a product?
- Can I see a product's alternative codes?
instructions:
- text: Get the alternative codes for product {id}.
slots:
id: path.id
- text: Show all alt SKUs mapped to product {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/AltCodes'].post
update:
x-apievangelist-phrasing:
intent: Add an alternative code to a product
effect: write
questions:
- How do I map an alternative SKU to a product?
- Can I add an Amazon or eBay SKU as an alternative code?
instructions:
- text: Add alternative code {SKU} of type {ConnectMappingType} to product {id}.
slots:
SKU: query.SKU
ConnectMappingType: query.ConnectMappingType
id: path.id
- text: Map {SKU} as an alternative SKU for product {id} using {ConnectMappingType}.
slots:
SKU: query.SKU
id: path.id
ConnectMappingType: query.ConnectMappingType
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/StockFlow/Filtered'].get
update:
x-apievangelist-phrasing:
intent: Get filtered stock flow for a product
effect: read
questions:
- How can I see only IN and OUT stock movements for a product in one warehouse during a date range?
- Can I narrow a product's stock flow history by flow type, warehouse or SKU?
- Can I exclude order and return related movements from a product's stock flow?
instructions:
- text: Show only {Types} stock flow for product {id} between {FromDate} and {ToDate}.
slots:
Types: query.Types
id: path.id
FromDate: query.FromDate
ToDate: query.ToDate
- text: Get filtered stock flow for SKU {SKU} (use product ID {id}) in warehouse {WarehouseId} from {FromDate} to {ToDate}.
slots:
SKU: query.SKU
id: path.id
WarehouseId: query.WarehouseId
FromDate: query.FromDate
ToDate: query.ToDate
- text: Filter stock flow for product {id} from {FromDate} to {ToDate}, with orders {IncludeOrders} and returns {IncludeReturns}.
slots:
id: path.id
FromDate: query.FromDate
ToDate: query.ToDate
IncludeOrders: query.IncludeOrders
IncludeReturns: query.IncludeReturns
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/Inventory'].get
update:
x-apievangelist-phrasing:
intent: Get a product's inventory
effect: read
questions:
- How much of a product do I have in stock?
- Can I break down a product's inventory by batch or best before date?
instructions:
- text: Get the inventory for product {id}.
slots:
id: path.id
- text: Show product {id}'s inventory with breakdown {breakdown}.
slots:
id: path.id
breakdown: query.breakdown
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/Inventory/Bulk'].get
update:
x-apievangelist-phrasing:
intent: Get inventory for many products
effect: read
questions:
- Can I get the inventory of several products in one page?
- Is there a paged call for product inventory across a warehouse?
instructions:
- text: Get inventory for products {Limit} per page.
slots:
Limit: query.Limit
- text: Show inventory for products updated since {LastUpdatedSince}.
slots:
LastUpdatedSince: query.LastUpdatedSince
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/Search'].get
update:
x-apievangelist-phrasing:
intent: Search products by SKU or name
effect: read
questions:
- How do I find a product by its SKU or name?
- Can I include discontinued products in a product search?
instructions:
- text: Search products for {Search}.
slots:
Search: query.Search
- text: Find products matching {Search}, including bundles {IncludeBundles}.
slots:
Search: query.Search
IncludeBundles: query.IncludeBundles
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/LookupProductId'].get
update:
x-apievangelist-phrasing:
intent: Look up a product by SKU or alternative code
effect: read
questions:
- How do I find a product's ID from its SKU?
- Can I look up a product by an alternative code?
instructions:
- text: Look up the product ID for SKU {SKU}.
slots:
SKU: query.SKU
- text: Find product {SKU} using alternative code {ConnectMappingType}.
slots:
SKU: query.SKU
ConnectMappingType: query.ConnectMappingType
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/SearchBarcode'].get
update:
x-apievangelist-phrasing:
intent: Find a product by barcode
effect: read
questions:
- How do I look up a product when I only have its barcode?
- Can I search a product by SKU, EAN, UPC or product ID?
instructions:
- text: Find the product with barcode {Barcode}.
slots:
Barcode: query.Barcode
- text: Look up product {Barcode} excluding product ID matches.
slots:
Barcode: query.Barcode
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/StockLevels'].get
update:
x-apievangelist-phrasing:
intent: Get stock levels for products
effect: read
questions:
- What stock do I have on hand for a product in a warehouse?
- Can I break stock down by batch or serial number?
instructions:
- text: Get stock levels for product {ProductId} in warehouse {WarehouseId}.
slots:
ProductId: query.ProductId
WarehouseId: query.WarehouseId
- text: Show stock levels for SKU {SKU} across all warehouses.
slots:
SKU: query.SKU
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/StockLevelsByWarehouse'].get
update:
x-apievangelist-phrasing:
intent: Get stock levels changed since a date
effect: read
questions:
- Which products had stock levels updated in a warehouse since a given date?
- Can I get raw stock levels for one warehouse filtered by last update time?
instructions:
- text: Get stock levels for warehouse {WarehouseId} updated since {LastUpdatedSince}.
slots:
WarehouseId: query.WarehouseId
LastUpdatedSince: query.LastUpdatedSince
- text: Show raw stock levels in warehouse {WarehouseId} changed since {LastUpdatedSince}.
slots:
WarehouseId: query.WarehouseId
LastUpdatedSince: query.LastUpdatedSince
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/Inventory/PreOrderBreakdown'].get
update:
x-apievangelist-phrasing:
intent: Break down pre-orders for a product
effect: read
questions:
- How many units of a product are on pre-order in a specific warehouse?
- Can I see the pre-order breakdown for one product and warehouse?
instructions:
- text: Get the pre-order breakdown for product {id} in warehouse {WarehouseId}.
slots:
id: path.id
WarehouseId: query.WarehouseId
- text: Show how many units of product {id} are reserved on pre-order in warehouse {WarehouseId}.
slots:
id: path.id
WarehouseId: query.WarehouseId
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/Inventory/PreOrderBreakdown/All'].get
update:
x-apievangelist-phrasing:
intent: Break down pre-orders across all warehouses
effect: read
questions:
- What is the total pre-order demand for a product across every warehouse?
- Can I see pre-orders for a product in all warehouses at once?
instructions:
- text: Get the pre-order breakdown for product {id} across all warehouses.
slots:
id: path.id
- text: Show total pre-order units for product {id} in every warehouse.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/UpdatedSince'].get
update:
x-apievangelist-phrasing:
intent: List products updated since a date
effect: read
questions:
- Which products were updated since a given date?
- Can I get a list of product IDs that changed recently?
instructions:
- text: List product IDs updated since {FromDate}.
slots:
FromDate: query.FromDate
- text: Show which products changed after {FromDate}.
slots:
FromDate: query.FromDate
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/StockLevels/UpdatedSince'].get
update:
x-apievangelist-phrasing:
intent: List products with stock levels changed since a date
effect: read
questions:
- Which products had their stock levels changed since a date?
- Can I get product IDs whose stock counts changed recently?
instructions:
- text: List product IDs whose stock levels changed since {FromDate}.
slots:
FromDate: query.FromDate
- text: Show products with updated stock levels after {FromDate}.
slots:
FromDate: query.FromDate
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/Suppliers'].get
update:
x-apievangelist-phrasing:
intent: List product suppliers
effect: read
questions:
- Who are the suppliers for a product?
- Can I page through product suppliers?
instructions:
- text: List product suppliers for client {ClientId}.
slots:
ClientId: query.ClientId
- text: Show page {PageNo} of product suppliers.
slots:
PageNo: query.PageNo
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/Suppliers'].put
update:
x-apievangelist-phrasing:
intent: Create a product supplier
effect: write
questions:
- How do I add a new supplier for a product?
- Can I create a supplier with a contact email and address?
instructions:
- text: Create a product supplier named {Name}.
slots:
Name: requestBody.Name
- text: Add supplier {Name} with contact {ContactName} and email {ContactEmail}.
slots:
Name: requestBody.Name
ContactName: requestBody.ContactName
ContactEmail: requestBody.ContactEmail
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/BulkOnHandStockUpdate'].post
update:
x-apievangelist-phrasing:
intent: Update on-hand stock levels in bulk
effect: write
questions:
- How do I set the on-hand stock level for many products at once?
- Do I need integer values when bulk updating stock?
instructions:
- text: Bulk update on-hand stock levels for client {ClientId}.
slots:
ClientId: query.ClientId
- text: Set the on-hand stock level for several products in one request.
method: generated
generated: '2026-11-20'
- target: $.paths['/api/Product/{id}/CustomFields'].post
update:
x-apievangelist-phrasing:
intent: Add a custom field to a product
effect: write
questions:
- How do I attach a custom field to a product?
- Can I store extra data against a product with a custom field?
instructions:
- text: Add custom field {CustomField} with value {Value} to product {id}.
slots:
CustomField: requestBody.CustomField
Value: requestBody.Value
id: path.id
- text: Attach custom field {CustomField} to product {id}.
slots:
CustomField: requestBody.CustomField
id: path.id
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-product-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.