Mintsoft · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Batch API

11 actions 11 updates phrasing extends openapi/mintsoft-batch-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/api/Batch'].post
$.paths['/api/Batch/AssignOrderToUser'].post
$.paths['/api/Batch/AssignBatchToUser'].post
$.paths['/api/Batch/List'].get
$.paths['/api/Batch/{id}'].get
$.paths['/api/Batch/StatusUpdate/{id}'].put
$.paths['/api/Batch/DespatchBatch'].post
$.paths['/api/Batch/Templates'].get
$.paths['/api/Batch/CreateBatchFromTemplate'].post
$.paths['/api/Batch/DeleteBatch'].delete

OpenAPI Overlay

mintsoft-batch-api-phrasing-overlay.yaml Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Batch API
  version: 1.0.0
extends: openapi/mintsoft-batch-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/Batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a batch of orders
      effect: write
      questions:
      - How do I group several order IDs into one batch?
      - Can I add a reference and success details when creating a batch?
      instructions:
      - text: Create a batch with the order IDs {OrderIds}.
        slots:
          OrderIds: requestBody.OrderIds
      - text: Create batch {ID} from orders {OrderIds} with reference {Reference}.
        slots:
          ID: requestBody.ID
          OrderIds: requestBody.OrderIds
          Reference: requestBody.Reference
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/AssignOrderToUser'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign one order to a picker
      effect: write
      questions:
      - How do I hand a single order over to a specific picker?
      - Can I assign an order to a user for picking?
      instructions:
      - text: Assign order {OrderID} to user {AssignToUser}.
        slots:
          OrderID: query.OrderID
          AssignToUser: query.AssignToUser
      - text: Hand order {OrderID} to picker {AssignToUser}.
        slots:
          OrderID: query.OrderID
          AssignToUser: query.AssignToUser
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/AssignBatchToUser'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a batch to a picker
      effect: write
      questions:
      - How do I assign an entire batch to a picker?
      - Can I set the picking priority and spot check when assigning a batch?
      instructions:
      - text: Assign batch {BatchID} to user {AssignToUser} with picking type {PickingType}.
        slots:
          BatchID: query.BatchID
          AssignToUser: query.AssignToUser
          PickingType: query.PickingType
      - text: Give batch {BatchID} to picker {AssignToUser} using priority {PickingPriority} and spot check {SpotCheck}.
        slots:
          BatchID: query.BatchID
          AssignToUser: query.AssignToUser
          PickingPriority: query.PickingPriority
          SpotCheck: query.SpotCheck
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/List'].get
  update:
    x-apievangelist-phrasing:
      intent: List picking batches
      effect: read
      questions:
      - Which picking batches exist in a warehouse?
      - Can I list only the batches that are picking complete?
      instructions:
      - text: List batches in warehouse {WarehouseId}.
        slots:
          WarehouseId: query.WarehouseId
      - text: Show batches created since {CreatedSince} with picking complete {PickingComplete}.
        slots:
          CreatedSince: query.CreatedSince
          PickingComplete: query.PickingComplete
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a batch's details
      effect: read
      questions:
      - What orders are in a particular batch?
      - Can I include order items when fetching a batch?
      instructions:
      - text: Get batch {id}.
        slots:
          id: path.id
      - text: Show batch {id} with order items {includeOrderItems}.
        slots:
          id: path.id
          includeOrderItems: query.includeOrderItems
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/StatusUpdate/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a batch's status
      effect: write
      questions:
      - How do I mark a batch as picked or closed?
      - Can I change the status of an existing batch?
      instructions:
      - text: Update batch {id} status to {OrderStatus}.
        slots:
          id: path.id
          OrderStatus: query.OrderStatus
      - text: Mark existing batch {id} as {OrderStatus}.
        slots:
          id: path.id
          OrderStatus: query.OrderStatus
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/DespatchBatch'].post
  update:
    x-apievangelist-phrasing:
      intent: Despatch a completed batch
      effect: write
      questions:
      - How do I despatch a batch that has been fully picked?
      - Can I send a completed batch out for delivery?
      instructions:
      - text: Despatch batch {batchId}.
        slots:
          batchId: query.batchId
      - text: Ship completed batch {batchId}.
        slots:
          batchId: query.batchId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/Templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List batch templates
      effect: read
      questions:
      - What batch templates are available for creating batches?
      - Which batch templates can I use to group orders?
      instructions:
      - text: List available batch templates.
      - text: Show the batch templates I can create batches from.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/CreateBatchFromTemplate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a batch from a template
      effect: write
      questions:
      - Can I create a batch using a batch template instead of listing orders?
      - Does creating a batch from a template respect the preview settings?
      instructions:
      - text: Create a batch from template {batchTemplateId}.
        slots:
          batchTemplateId: query.batchTemplateId
      - text: Generate a batch using batch template {batchTemplateId} without preview settings.
        slots:
          batchTemplateId: query.batchTemplateId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Batch/DeleteBatch'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a batch
      effect: destructive
      questions:
      - How do I delete a batch and unassign its orders?
      - Are the orders deleted when a batch is removed?
      instructions:
      - text: Delete batch {batchId}.
        slots:
          batchId: query.batchId
      - text: Remove batch {batchId} and unassign its orders.
        slots:
          batchId: query.batchId
      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.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/mintsoft-batch-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.