Mintsoft · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Order Rules API
12 actions
12 updates
phrasing
extends
openapi/mintsoft-orderrules-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 12
$.info
$.paths['/api/OrderRules'].get
$.paths['/api/OrderRules'].put
$.paths['/api/OrderRules'].post
$.paths['/api/OrderRules/{id}'].delete
$.paths['/api/OrderRules/{id}/Activate'].post
$.paths['/api/OrderRules/{id}/Deactivate'].post
$.paths['/api/OrderRules/{orderRuleId}/Conditions'].post
$.paths['/api/OrderRules/Conditions/{id}'].delete
$.paths['/api/OrderRules/Actions'].get
$.paths['/api/OrderRules/ConditionOptions'].get
$.paths['/api/OrderRules/Run/{orderId}'].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 Order Rules API
version: 1.0.0
extends: openapi/mintsoft-orderrules-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: 11
- target: $.paths['/api/OrderRules'].get
update:
x-apievangelist-phrasing:
intent: List order rules
effect: read
questions:
- Which order rules are configured for a client?
- Can I see all order rules in the system?
instructions:
- text: List order rules for client {clientId}.
slots:
clientId: query.clientId
- text: Show every order rule.
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules'].put
update:
x-apievangelist-phrasing:
intent: Update an existing order rule
effect: write
questions:
- How do I change the warehouse an order rule applies to?
- Can I deactivate an order rule without deleting it?
instructions:
- text: Set order rule {ID} to apply to warehouse {WarehouseId}.
slots:
ID: requestBody.ID
WarehouseId: requestBody.WarehouseId
- text: Deactivate order rule {ID} by setting Active to {Active}.
slots:
ID: requestBody.ID
Active: requestBody.Active
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules'].post
update:
x-apievangelist-phrasing:
intent: Add a new order rule
effect: write
questions:
- How do I create an order rule that blocks orders from a specific channel?
- Can I set a new order rule's priority when I create it?
instructions:
- text: Add a new order rule for client {ClientId} that runs {Action} when {ConditionType} is {Param}.
slots:
ClientId: requestBody.ClientId
Action: requestBody.Action
ConditionType: requestBody.ConditionType
Param: requestBody.Param
- text: Create an order rule with priority {Priority}.
slots:
Priority: requestBody.Priority
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an order rule
effect: destructive
questions:
- How do I remove an order rule I no longer use?
- Can I delete an order rule by its ID?
instructions:
- text: Delete order rule {id}.
slots:
id: path.id
- text: Remove the order rule with ID {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules/{id}/Activate'].post
update:
x-apievangelist-phrasing:
intent: Activate an order rule
effect: write
questions:
- How do I turn an inactive order rule back on?
- Can I activate an order rule by its ID?
instructions:
- text: Activate order rule {id}.
slots:
id: path.id
- text: Turn on the inactive order rule {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules/{id}/Deactivate'].post
update:
x-apievangelist-phrasing:
intent: Deactivate an order rule
effect: write
questions:
- How do I pause an order rule without deleting it?
- Can I deactivate an order rule by its ID?
instructions:
- text: Deactivate order rule {id}.
slots:
id: path.id
- text: Pause the order rule with ID {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules/{orderRuleId}/Conditions'].post
update:
x-apievangelist-phrasing:
intent: Add a condition to an order rule
effect: write
questions:
- How do I make an order rule check the customer's country?
- Can I add a condition to an existing order rule?
instructions:
- text: Add a {Operator} condition on {Field} with value {Value} to order rule {orderRuleId}.
slots:
Operator: requestBody.Operator
Field: requestBody.Field
Value: requestBody.Value
orderRuleId: path.orderRuleId
- text: Append a country condition to order rule {orderRuleId}.
slots:
orderRuleId: path.orderRuleId
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules/Conditions/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Remove one condition from an order rule
effect: destructive
questions:
- How do I take out a single condition from an order rule?
- Can I delete one condition without deleting the whole order rule?
instructions:
- text: Delete condition {id} from this order rule.
slots:
id: path.id
- text: Remove order rule condition {id}.
slots:
id: path.id
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules/Actions'].get
update:
x-apievangelist-phrasing:
intent: List possible order rule actions
effect: read
questions:
- What actions can an order rule take, like hold or ship?
- Which order rule actions are available?
instructions:
- text: List the possible order rule actions.
- text: Show every action an order rule can perform.
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules/ConditionOptions'].get
update:
x-apievangelist-phrasing:
intent: List order rule condition fields and operators
effect: read
questions:
- Which fields and operators can I use in an order rule condition?
- What condition types and values are supported?
instructions:
- text: List the possible order rule condition fields and operators.
- text: Show the condition options for building order rules.
method: generated
generated: '2026-11-20'
- target: $.paths['/api/OrderRules/Run/{orderId}'].post
update:
x-apievangelist-phrasing:
intent: Run order rules against an order
effect: read
questions:
- How do I check whether an order matches any of my order rules?
- Can I test a single order against all order rules?
instructions:
- text: Run order rules against order {orderId}.
slots:
orderId: path.orderId
- text: Check order {orderId} for matching order rules.
slots:
orderId: path.orderId
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-orderrules-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.