Mintsoft · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Warehouse API

19 actions 19 updates phrasing extends openapi/mintsoft-warehouse-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 19 · first 16 shown; the file carries all of them

$.info
$.paths['/api/Warehouse/LocationTypes'].get
$.paths['/api/Warehouse'].get
$.paths['/api/Warehouse/{WarehouseId}/Location/All'].get
$.paths['/api/Warehouse/{WarehouseId}/Location/{LocationId}'].get
$.paths['/api/Warehouse/{WarehouseId}/Location/LookupLocationId'].get
$.paths['/api/Warehouse/{warehouseId}/StockMovements'].get
$.paths['/api/Warehouse/StockMovement'].post
$.paths['/api/Warehouse/BulkStockMovement'].post
$.paths['/api/WarehouseTransfer'].put
$.paths['/api/WarehouseTransfer/List'].get
$.paths['/api/WarehouseTransfer/{id}'].get
$.paths['/api/WarehouseTransfer/{id}'].post
$.paths['/api/WarehouseTransfer/{id}'].delete
$.paths['/api/WarehouseTransfer/Statuses'].get
$.paths['/api/WarehouseTransfer/{id}/Confirm'].get

OpenAPI Overlay

mintsoft-warehouse-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 Warehouse API
  version: 1.0.0
extends: openapi/mintsoft-warehouse-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: 18
- target: $.paths['/api/Warehouse/LocationTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List location types
      effect: read
      questions:
      - What location types are available for a warehouse?
      - Which location types can I use when setting up a warehouse?
      instructions:
      - text: List the location types.
      - text: Show every location type available.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse'].get
  update:
    x-apievangelist-phrasing:
      intent: List warehouses
      effect: read
      questions:
      - Which warehouses can I access?
      - What warehouse IDs do I have access to?
      instructions:
      - text: List my warehouses.
      - text: Show the warehouses I can access.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse/{WarehouseId}/Location/All'].get
  update:
    x-apievangelist-phrasing:
      intent: List a warehouse's locations
      effect: read
      questions:
      - What locations are in a warehouse?
      - Can I include unassigned locations when listing a warehouse's locations?
      instructions:
      - text: List the locations in warehouse {WarehouseId}.
        slots:
          WarehouseId: path.WarehouseId
      - text: 'List locations in {WarehouseId} including unassigned ones: {IncludeUnAssigned}.'
        slots:
          WarehouseId: path.WarehouseId
          IncludeUnAssigned: query.IncludeUnAssigned
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse/{WarehouseId}/Location/{LocationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a warehouse location
      effect: read
      questions:
      - How do I look up one location in a warehouse?
      - What details come back for a single warehouse location?
      instructions:
      - text: Get location {LocationId} in warehouse {WarehouseId}.
        slots:
          LocationId: path.LocationId
          WarehouseId: path.WarehouseId
      - text: Show warehouse {WarehouseId} location {LocationId}.
        slots:
          WarehouseId: path.WarehouseId
          LocationId: path.LocationId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse/{WarehouseId}/Location/LookupLocationId'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a warehouse location by name
      effect: read
      questions:
      - How do I find a location's ID by its name?
      - Can I look up a warehouse location by its name?
      instructions:
      - text: Look up location {Location} in warehouse {WarehouseId}.
        slots:
          Location: query.Location
          WarehouseId: path.WarehouseId
      - text: Find the ID of the {Location} location in {WarehouseId}.
        slots:
          Location: query.Location
          WarehouseId: path.WarehouseId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse/{warehouseId}/StockMovements'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock movements in a warehouse
      effect: read
      questions:
      - What stock movements have happened in a warehouse?
      - Can I filter a warehouse's stock movements by product or date?
      instructions:
      - text: List stock movements in warehouse {warehouseId}.
        slots:
          warehouseId: path.warehouseId
      - text: Show stock movements for product {productId} in {warehouseId} since {sinceDate}.
        slots:
          productId: query.productId
          warehouseId: path.warehouseId
          sinceDate: query.sinceDate
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse/StockMovement'].post
  update:
    x-apievangelist-phrasing:
      intent: Book a stock movement
      effect: write
      questions:
      - How do I book a stock movement into or out of a location?
      - Can I record a stock adjustment with an expiry date and batch number?
      instructions:
      - text: Book a {Action} of {Quantity} units of product {ProductId} into location {LocationId} in warehouse {WarehouseId}.
        slots:
          Action: query.Action
          Quantity: requestBody.Quantity
          ProductId: requestBody.ProductId
          LocationId: requestBody.LocationId
          WarehouseId: requestBody.WarehouseId
      - text: Record a {Action} stock movement for {Quantity} units of {ProductId} at {LocationId} in {WarehouseId} with comment {Comment}.
        slots:
          Action: query.Action
          Quantity: requestBody.Quantity
          ProductId: requestBody.ProductId
          LocationId: requestBody.LocationId
          WarehouseId: requestBody.WarehouseId
          Comment: requestBody.Comment
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse/BulkStockMovement'].post
  update:
    x-apievangelist-phrasing:
      intent: Perform several stock movements at once
      effect: write
      questions:
      - Can I book many stock movements with the same action in one call?
      - How do I record a batch of stock adjustments?
      instructions:
      - text: Perform a batch of {Action} stock movements.
        slots:
          Action: query.Action
      - text: Book several stock movements with action {Action} in one request.
        slots:
          Action: query.Action
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/WarehouseTransfer'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a warehouse transfer
      effect: write
      questions:
      - How do I record a goods-in delivery into a warehouse?
      - Can a warehouse transfer include items, a courier and a delivery date?
      - Which status can a new warehouse transfer start with?
      instructions:
      - text: Create a warehouse transfer from {SourceWarehouseId} to {DestinationWarehouseId}.
        slots:
          SourceWarehouseId: requestBody.SourceWarehouseId
          DestinationWarehouseId: requestBody.DestinationWarehouseId
      - text: Record a goods-in delivery with reference {Reference} to {DestinationWarehouseId}.
        slots:
          Reference: requestBody.Reference
          DestinationWarehouseId: requestBody.DestinationWarehouseId
      - text: Record warehouse transfer {Reference} of {Quantity} items, expected {ExpectedDeliveryDate}.
        slots:
          Reference: requestBody.Reference
          Quantity: requestBody.Quantity
          ExpectedDeliveryDate: requestBody.ExpectedDeliveryDate
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/WarehouseTransfer/List'].get
  update:
    x-apievangelist-phrasing:
      intent: List warehouse transfers
      effect: read
      questions:
      - What warehouse transfers are in the system?
      - Can I filter warehouse transfers by status or client?
      instructions:
      - text: List warehouse transfers.
      - text: Show warehouse transfers with status {WarehouseTransferStatuses}.
        slots:
          WarehouseTransferStatuses: query.WarehouseTransferStatuses
      - text: List warehouse transfers for client {ClientId}.
        slots:
          ClientId: query.ClientId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/WarehouseTransfer/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a warehouse transfer
      effect: read
      questions:
      - What are the latest details of a warehouse transfer?
      - Can I see the items on a warehouse transfer?
      instructions:
      - text: Get warehouse transfer {id}.
        slots:
          id: path.id
      - text: Show the latest details of warehouse transfer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/WarehouseTransfer/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a warehouse transfer
      effect: write
      questions:
      - How do I change the expected delivery date of a warehouse transfer?
      - Can I update a warehouse transfer's status without touching its items?
      instructions:
      - text: Update warehouse transfer {id} to expected delivery date {ExpectedDeliveryDate}.
        slots:
          id: path.id
          ExpectedDeliveryDate: requestBody.ExpectedDeliveryDate
      - text: Change the status of warehouse transfer {id} to {WarehouseTransferStatus}.
        slots:
          id: path.id
          WarehouseTransferStatus: requestBody.WarehouseTransferStatus
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/WarehouseTransfer/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a warehouse transfer
      effect: destructive
      questions:
      - How do I delete a warehouse transfer?
      - Can a deleted warehouse transfer be undone?
      instructions:
      - text: Delete warehouse transfer {id}.
        slots:
          id: path.id
      - text: Remove warehouse transfer {id} from the system.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/WarehouseTransfer/Statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List warehouse transfer statuses
      effect: read
      questions:
      - What statuses can a warehouse transfer have?
      - Which warehouse transfer statuses are available?
      instructions:
      - text: List the warehouse transfer statuses.
      - text: Show every possible warehouse transfer status.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/WarehouseTransfer/{id}/Confirm'].get
  update:
    x-apievangelist-phrasing:
      intent: Confirm a warehouse transfer
      effect: write
      questions:
      - How do I confirm a warehouse transfer is ready to arrive?
      - Can I mark a warehouse transfer as confirmed?
      instructions:
      - text: Confirm warehouse transfer {id}.
        slots:
          id: path.id
      - text: Mark warehouse transfer {id} as confirmed.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/WarehouseTransfer/{id}/Cancel'].get
  update:
    x-apievangelist-phrasing:
      intent: Cancel a warehouse transfer
      effect: destructive
      questions:
      - How do I cancel a warehouse transfer?
      - Can I cancel a warehouse transfer that hasn't arrived yet?
      instructions:
      - text: Cancel warehouse transfer {id}.
        slots:
          id: path.id
      - text: Cancel the warehouse transfer {id} so it is no longer expected.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse/{id}/Zones'].get
  update:
    x-apievangelist-phrasing:
      intent: List a warehouse's zones
      effect: read
      questions:
      - What zones are in a warehouse?
      - Can I list the zones of a warehouse I have access to?
      instructions:
      - text: List the zones in warehouse {id}.
        slots:
          id: path.id
      - text: Show the zones of warehouse {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Warehouse/{id}/ToteBreakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down a tote's contents
      effect: read
      questions:
      - What products are in a tote and what are their dimensions?
      - Can I see the tote breakdown for a tote barcode?
      instructions:
      - text: Get the tote breakdown for tote {toteBarcode} in warehouse {id}.
        slots:
          toteBarcode: query.toteBarcode
          id: path.id
      - text: Show the products in tote {toteBarcode} and their dimensions.
        slots:
          toteBarcode: query.toteBarcode
      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-warehouse-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.