Mintsoft · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ASN API

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

$.info
$.paths['/api/ASN'].put
$.paths['/api/ASN/{id}'].get
$.paths['/api/ASN/{id}'].post
$.paths['/api/ASN/{id}'].delete
$.paths['/api/ASN/List'].get
$.paths['/api/ASN/{id}/ConnectActions'].put
$.paths['/api/ASN/Statuses'].get
$.paths['/api/ASN/GoodsInTypes'].get
$.paths['/api/ASN/{id}/Confirm'].get
$.paths['/api/ASN/{id}/BookIn'].get
$.paths['/api/ASN/{id}/BookInPartial'].get
$.paths['/api/ASN/{id}/PartBook'].get
$.paths['/api/ASN/{id}/Paperwork'].get
$.paths['/api/ASN/{id}/Items/Receive'].post
$.paths['/api/ASN/{id}/MarkAwaitingPutAway'].get

OpenAPI Overlay

mintsoft-asn-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 ASN API
  version: 1.0.0
extends: openapi/mintsoft-asn-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: 16
- target: $.paths['/api/ASN'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an Advanced Shipping Notice
      effect: write
      questions:
      - How do I advise a delivery into the warehouse with an Advanced Shipping Notice?
      - Can I pre-advice serial numbers on an ASN when I create it?
      instructions:
      - text: Create an ASN for PO {POReference} from {Supplier} arriving at {WarehouseId}.
        slots:
          POReference: requestBody.POReference
          Supplier: requestBody.Supplier
          WarehouseId: requestBody.WarehouseId
      - text: Create an ASN for {ProductSupplierId} with serial numbers {Items}.
        slots:
          ProductSupplierId: requestBody.ProductSupplierId
          Items: requestBody.Items
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Advanced Shipping Notice
      effect: read
      questions:
      - What are the latest details of an ASN?
      - Can I look up one Advanced Shipping Notice by its ID?
      instructions:
      - text: Get ASN {id}.
        slots:
          id: path.id
      - text: Show the details of Advanced Shipping Notice {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an Advanced Shipping Notice
      effect: write
      questions:
      - How do I change the estimated delivery date on an existing ASN?
      - Can I replace the pre-advised serial numbers on an ASN?
      instructions:
      - text: Update ASN {id} to arrive at {WarehouseId}.
        slots:
          id: path.id
          WarehouseId: requestBody.WarehouseId
      - text: Change the estimated delivery of ASN {id} to {EstimatedDelivery}.
        slots:
          id: path.id
          EstimatedDelivery: requestBody.EstimatedDelivery
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Advanced Shipping Notice
      effect: destructive
      questions:
      - Can I delete an ASN I no longer need?
      - Is deleting an Advanced Shipping Notice reversible?
      instructions:
      - text: Delete ASN {id}.
        slots:
          id: path.id
      - text: Remove Advanced Shipping Notice {id} from the system.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/List'].get
  update:
    x-apievangelist-phrasing:
      intent: List Advanced Shipping Notices
      effect: read
      questions:
      - Which ASNs are still awaiting put away?
      - Can I list ASNs for one client or warehouse?
      - How do I see ASNs updated since a certain time?
      instructions:
      - text: List ASNs for client {ClientId}.
        slots:
          ClientId: query.ClientId
      - text: Show ASNs at warehouse {WarehouseId} with status {ASNStatusId}.
        slots:
          WarehouseId: query.WarehouseId
          ASNStatusId: query.ASNStatusId
      - text: List ASNs updated since {SinceLastUpdated}.
        slots:
          SinceLastUpdated: query.SinceLastUpdated
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/ConnectActions'].put
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook for an ASN
      effect: write
      questions:
      - How do I get a webhook called when an ASN is booked in?
      - Can I register a Connect action for an Advanced Shipping Notice?
      instructions:
      - text: Register a {Type} Connect action on ASN {id}.
        slots:
          Type: requestBody.Type
          id: path.id
      - text: Set up a webhook for ASN {id} with extra codes {ExtraCode1}, {ExtraCode2}.
        slots:
          id: path.id
          ExtraCode1: requestBody.ExtraCode1
          ExtraCode2: requestBody.ExtraCode2
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/Statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List ASN statuses
      effect: read
      questions:
      - What status values can an Advanced Shipping Notice have?
      - Which ASN status IDs are valid?
      instructions:
      - text: List all ASN statuses.
      - text: Show the possible values for an Advanced Shipping Notice status.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/GoodsInTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List goods-in types
      effect: read
      questions:
      - What goods-in types like Pallet or Container are available?
      - Which goods-in type values can I use on an ASN?
      instructions:
      - text: List the available goods-in types.
      - text: Show the goods-in type values for an Advanced Shipping Notice.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/Confirm'].get
  update:
    x-apievangelist-phrasing:
      intent: Confirm an ASN is ready
      effect: write
      questions:
      - How do I mark an ASN as ready to be expected in the warehouse?
      - Can I confirm an Advanced Shipping Notice before it arrives?
      instructions:
      - text: Confirm ASN {id}.
        slots:
          id: path.id
      - text: Mark Advanced Shipping Notice {id} as ready for the warehouse.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/BookIn'].get
  update:
    x-apievangelist-phrasing:
      intent: Book in an ASN in full
      effect: write
      questions:
      - How do I record that every item on an ASN has arrived?
      - Can I mark an Advanced Shipping Notice as fully booked in?
      instructions:
      - text: Book in ASN {id} completely.
        slots:
          id: path.id
      - text: Record that all items on Advanced Shipping Notice {id} have arrived.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/BookInPartial'].get
  update:
    x-apievangelist-phrasing:
      intent: Partially book in an ASN
      effect: write
      questions:
      - How do I record that only some items on an ASN have arrived?
      - Can I partially book in an Advanced Shipping Notice?
      instructions:
      - text: Partially book in ASN {id}.
        slots:
          id: path.id
      - text: Record that some items on Advanced Shipping Notice {id} have arrived.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/PartBook'].get
  update:
    x-apievangelist-phrasing:
      intent: Record received items on an ASN
      effect: write
      questions:
      - How do I record the items I've already received against an ASN?
      - Can I update an Advanced Shipping Notice with partial receipts?
      instructions:
      - text: Record the received items against ASN {id}.
        slots:
          id: path.id
      - text: Update Advanced Shipping Notice {id} with the items received so far.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/Paperwork'].get
  update:
    x-apievangelist-phrasing:
      intent: Get paperwork for an ASN
      effect: read
      questions:
      - Where can I find the paperwork attached to an ASN?
      - Can I download the documents for an Advanced Shipping Notice?
      instructions:
      - text: Get the paperwork for ASN {id}.
        slots:
          id: path.id
      - text: Show the documents attached to Advanced Shipping Notice {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/Items/Receive'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive items against an ASN
      effect: write
      questions:
      - How do I record receiving items against an Advanced Shipping Notice?
      - Can I add received items to an ASN after the fact?
      instructions:
      - text: Receive items against ASN {id}.
        slots:
          id: path.id
      - text: Record that items were received for Advanced Shipping Notice {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/MarkAwaitingPutAway'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an ASN as awaiting put away
      effect: write
      questions:
      - How do I mark an ASN as awaiting put away?
      - Can I set an Advanced Shipping Notice to awaiting put away?
      instructions:
      - text: Mark ASN {id} as awaiting put away.
        slots:
          id: path.id
      - text: Set Advanced Shipping Notice {id} to awaiting put away.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/ASN/{id}/MarkPutAwayComplete'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an ASN as put away complete
      effect: write
      questions:
      - How do I mark an ASN as fully put away?
      - Can I complete an Advanced Shipping Notice once put away?
      instructions:
      - text: Mark ASN {id} as put away complete.
        slots:
          id: path.id
      - text: Complete Advanced Shipping Notice {id} by marking it put away.
        slots:
          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.
All 92 tools →

Call it yourself

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