Mintsoft · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Order API

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

$.info
$.paths['/api/Order/Statuses'].get
$.paths['/api/Order/Documents/DocumentTypes'].get
$.paths['/api/Order/Documents/PaperSizes'].get
$.paths['/api/Order/Shipments/TrackingEvents/Statuses'].get
$.paths['/api/Order/Shipments/TrackingEvents/List'].get
$.paths['/api/Order'].put
$.paths['/api/Order/{id}'].get
$.paths['/api/Order/{id}'].post
$.paths['/api/Order/Search'].get
$.paths['/api/Order/GetOrderId'].get
$.paths['/api/Order/TrackingNumberSearch'].get
$.paths['/api/Order/Channels'].get
$.paths['/api/Order/List'].get
$.paths['/api/Order/{id}/Items'].get
$.paths['/api/Order/{id}/Items'].put

OpenAPI Overlay

mintsoft-order-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 Order API
  version: 1.0.0
extends: openapi/mintsoft-order-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: 55
- target: $.paths['/api/Order/Statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List order statuses
      effect: read
      questions:
      - What order statuses can an order be in?
      - Which status means an order is ready to despatch?
      instructions:
      - text: List all order statuses.
      - text: Show the possible order status values.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/Documents/DocumentTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List order document types
      effect: read
      questions:
      - What types of documents can be generated for an order?
      - Which document types are available for order invoices?
      instructions:
      - text: List order document types.
      - text: Show the available order document types.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/Documents/PaperSizes'].get
  update:
    x-apievangelist-phrasing:
      intent: List order document paper sizes
      effect: read
      questions:
      - What paper sizes can order documents be printed on?
      - Which paper sizes are supported for order invoices?
      instructions:
      - text: List order document paper sizes.
      - text: Show the supported paper sizes for order documents.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/Shipments/TrackingEvents/Statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking event statuses
      effect: read
      questions:
      - What statuses can a shipment tracking event have?
      - Which tracking statuses are possible for an order's parcels?
      instructions:
      - text: List tracking event statuses.
      - text: Show the possible shipment tracking statuses.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/Shipments/TrackingEvents/List'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipment tracking events
      effect: read
      questions:
      - What shipment tracking events have happened across my orders?
      - Can I list only tracking events with a particular tracking status?
      - Is it possible to fetch tracking events that happened since a certain time?
      instructions:
      - text: List shipment tracking events since {SinceLastUpdated}.
        slots:
          SinceLastUpdated: query.SinceLastUpdated
      - text: List shipment tracking events with tracking status {TrackingStatusId}.
        slots:
          TrackingStatusId: query.TrackingStatusId
      - text: Get page {PageNo} of shipment tracking events, {Limit} per page.
        slots:
          PageNo: query.PageNo
          Limit: query.Limit
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an order
      effect: write
      questions:
      - How do I create a new order with items and a shipping address?
      - Can I set the courier, warehouse and delivery date when creating an order?
      instructions:
      - text: Create an order with items {OrderItems}.
        slots:
          OrderItems: requestBody.OrderItems
      - text: Create order {OrderNameValues} for client {ClientId} with {OrderItems}.
        slots:
          OrderNameValues: requestBody.OrderNameValues
          ClientId: requestBody.ClientId
          OrderItems: requestBody.OrderItems
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order
      effect: read
      questions:
      - How do I view one order's details?
      - Can I look up an order by its ID?
      instructions:
      - text: Get order {id}.
        slots:
          id: path.id
      - text: Show the details of order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an order's details
      effect: write
      questions:
      - How do I change the shipping address on an existing order?
      - Can I update the delivery date or comments on an order?
      instructions:
      - text: Update order {id} with shipping address {Address1}, {Town}, {PostCode}.
        slots:
          id: path.id
          Address1: requestBody.Address1
          Town: requestBody.Town
          PostCode: requestBody.PostCode
      - text: Set the delivery date of order {id} to {DeliveryDate}.
        slots:
          id: path.id
          DeliveryDate: requestBody.DeliveryDate
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/Search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search orders by number or tracking number
      effect: read
      questions:
      - How do I find an order by its order number?
      - Can I search orders by tracking number?
      instructions:
      - text: Search orders for {OrderNumber}.
        slots:
          OrderNumber: query.OrderNumber
      - text: Find the order with number {OrderNumber} using an exact match.
        slots:
          OrderNumber: query.OrderNumber
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/GetOrderId'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an order ID by number
      effect: read
      questions:
      - How do I get the order ID for a given order number?
      - Can I look up an order by its number at a specific warehouse?
      instructions:
      - text: Get the order ID for order number {orderNumber}.
        slots:
          orderNumber: query.orderNumber
      - text: Look up order {orderNumber} at warehouse {warehouseId}.
        slots:
          orderNumber: query.orderNumber
          warehouseId: query.warehouseId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/TrackingNumberSearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Find an order by tracking number
      effect: read
      questions:
      - How do I find an order from its tracking number?
      - Can I include order items when searching by tracking number?
      instructions:
      - text: Find the order for tracking number {tracking}.
        slots:
          tracking: query.TrackingNumber
      - text: Search order {tracking} with items included.
        slots:
          tracking: query.TrackingNumber
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/Channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List order channels
      effect: read
      questions:
      - Which sales channels can orders come from?
      - What channel IDs are available for filtering orders?
      instructions:
      - text: List order channels.
      - text: Show the available order channels.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/List'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders
      effect: read
      questions:
      - How do I list all orders in the system?
      - Can I filter orders by status, channel or warehouse?
      - Is it possible to list only orders that were last updated since a date?
      instructions:
      - text: List all orders.
      - text: List orders with status {OrderStatusId}.
        slots:
          OrderStatusId: query.OrderStatusId
      - text: List orders from channel {ChannelId}.
        slots:
          ChannelId: query.ChannelId
      - text: List orders last updated since {SinceLastUpdated}.
        slots:
          SinceLastUpdated: query.SinceLastUpdated
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Items'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's items
      effect: read
      questions:
      - How do I see the line items on an order?
      - What products are included in a specific order?
      instructions:
      - text: List the items on order {id}.
        slots:
          id: path.id
      - text: Show every product in order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Items'].put
  update:
    x-apievangelist-phrasing:
      intent: Add an item to an order
      effect: write
      questions:
      - How do I add a new product to an existing order?
      - Can I add an item with a requested serial or batch number?
      instructions:
      - text: Add item {SKU} with quantity {Quantity} to order {id}.
        slots:
          SKU: requestBody.SKU
          Quantity: requestBody.Quantity
          id: path.id
      - text: Add product {ProductId} to order {id} at warehouse {WarehouseId}.
        slots:
          ProductId: requestBody.ProductId
          id: path.id
          WarehouseId: requestBody.WarehouseId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Items/{ItemId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an item on an order
      effect: write
      questions:
      - How do I change the quantity of an item on an order?
      - Can I edit the details or discount on an existing order item?
      instructions:
      - text: Change the quantity of item {ItemId} on order {id} to {Quantity}.
        slots:
          ItemId: path.ItemId
          id: path.id
          Quantity: requestBody.Quantity
      - text: Update item {ItemId} on order {id} with details {Details}.
        slots:
          ItemId: path.ItemId
          id: path.id
          Details: requestBody.Details
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Items/{ItemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an item from an order
      effect: destructive
      questions:
      - How do I remove a product from an order?
      - Can I delete an order item by its ID?
      instructions:
      - text: Delete item {ItemId} from order {id}.
        slots:
          ItemId: path.ItemId
          id: path.id
      - text: Remove product {ItemId} from order {id}.
        slots:
          ItemId: path.ItemId
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Cancel'].get
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order
      effect: destructive
      questions:
      - How do I cancel an order that hasn't shipped yet?
      - Can I cancel an order as a client?
      instructions:
      - text: Cancel order {id}.
        slots:
          id: path.id
      - text: Cancel order {id} as a client.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/CancelNoStock'].get
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order for no stock
      effect: destructive
      questions:
      - How do I cancel an order because the product is out of stock?
      - Can I mark an order as cancelled for no stock?
      instructions:
      - text: Cancel order {id} as no stock.
        slots:
          id: path.id
      - text: Mark order {id} as cancelled for no stock.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkDespatched'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an order as despatched
      effect: write
      questions:
      - How do I mark an order as despatched and set its tracking number?
      - Can I record a despatch date on an order?
      instructions:
      - text: Mark order {id} as despatched.
        slots:
          id: path.id
      - text: Mark order {id} as despatched with tracking number {TrackingNumber}.
        slots:
          id: path.id
          TrackingNumber: query.TrackingNumber
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkPrinted'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an order as printed
      effect: write
      questions:
      - How do I mark an order as printed?
      - Can I leave a comment when marking an order printed?
      instructions:
      - text: Mark order {id} as printed.
        slots:
          id: path.id
      - text: Mark order {id} as printed with comment {comment}.
        slots:
          id: path.id
          comment: query.Comment
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/UpdateNumberOfParcels'].get
  update:
    x-apievangelist-phrasing:
      intent: Update the number of parcels on an order
      effect: write
      questions:
      - How do I change how many parcels an order is split into?
      - Can I update the parcel count on an order?
      instructions:
      - text: Update the number of parcels on order {id} to {parcels}.
        slots:
          id: path.id
          parcels: query.NumberOfParcels
      - text: Set order {id} parcel count to {parcels}.
        slots:
          id: path.id
          parcels: query.NumberOfParcels
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkAwaitingPayment'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an order as awaiting payment
      effect: write
      questions:
      - How do I move an order back to awaiting payment?
      - Can I set an order's status to awaiting payment?
      instructions:
      - text: Mark order {id} as awaiting payment.
        slots:
          id: path.id
      - text: Set order {id} status back to awaiting payment.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkPaymentReceived'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an order as payment received
      effect: write
      questions:
      - How do I confirm payment has been received on an order?
      - Can I move an order from awaiting payment to paid?
      instructions:
      - text: Mark order {id} as payment received.
        slots:
          id: path.id
      - text: Record payment received on order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkAwaitingConfirmation'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an order as awaiting confirmation
      effect: write
      questions:
      - How do I hold an order while waiting for confirmation?
      - Can I set an order's status to awaiting confirmation?
      instructions:
      - text: Mark order {id} as awaiting confirmation.
        slots:
          id: path.id
      - text: Set order {id} status to awaiting confirmation.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkConfirmed'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an order as confirmed
      effect: write
      questions:
      - How do I confirm an order after it's been confirmed?
      - Can I move an order from awaiting confirmation to confirmed?
      instructions:
      - text: Mark order {id} as confirmed.
        slots:
          id: path.id
      - text: Confirm order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkPackAndHold'].get
  update:
    x-apievangelist-phrasing:
      intent: Hold an order for later despatch
      effect: write
      questions:
      - How do I hold an order until a future release date?
      - Can I pack an order and hold it for later despatch?
      instructions:
      - text: Mark order {id} as pack and hold, releasing on {date}.
        slots:
          id: path.id
          date: query.ReleaseDate
      - text: Hold order {id} until {date}.
        slots:
          id: path.id
          date: query.ReleaseDate
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkReleasePackAndHold'].get
  update:
    x-apievangelist-phrasing:
      intent: Release a pack-and-hold order
      effect: write
      questions:
      - How do I release an order that's been held for pack and hold?
      - Can I bring a pack-and-hold order back to its original status?
      instructions:
      - text: Release order {id} from pack and hold.
        slots:
          id: path.id
      - text: Move pack-and-hold order {id} back to its original status.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/DespatchNote'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's despatch note
      effect: read
      questions:
      - Where do I get the despatch note for an order?
      - Can I view the despatch note for an order?
      instructions:
      - text: Get the despatch note for order {id}.
        slots:
          id: path.id
      - text: Show the despatch note of order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Comments'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's comments
      effect: read
      questions:
      - What comments have been left on an order?
      - Can I read the comments on an order?
      instructions:
      - text: Get the comments on order {id}.
        slots:
          id: path.id
      - text: Show all comments for order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to an order
      effect: write
      questions:
      - How do I add a comment to an order?
      - Can I leave a note on an order as an admin?
      instructions:
      - text: Add comment {comment} to order {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Leave a note on order {id} saying {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Splits'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's splits
      effect: read
      questions:
      - How do I see how an order has been split?
      - Can I view the splits of an order?
      instructions:
      - text: Get the splits of order {id}.
        slots:
          id: path.id
      - text: Show how order {id} is split.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's documents
      effect: read
      questions:
      - Which documents are attached to an order?
      - Can I list all documents on an order?
      instructions:
      - text: List the documents on order {id}.
        slots:
          id: path.id
      - text: Show every document attached to order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Documents'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a document to an order
      effect: write
      questions:
      - How do I attach a document to an order?
      - Can I upload a document to an order and choose its paper size?
      instructions:
      - text: Upload document {name} to order {id} as type {type}, printed with the order.
        slots:
          name: requestBody.FileName
          id: path.id
          type: query.DocumentTypeId
      - text: 'Add a {size} document to order {id} of type {type}, printed with the order: {print}.'
        slots:
          size: query.PaperSize
          id: path.id
          type: query.DocumentTypeId
          print: query.PrintWithOrder
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Documents/{DocumentId}/Data'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an order document
      effect: read
      questions:
      - How do I download the data of an order document?
      - Can I fetch the file data of an order document?
      instructions:
      - text: Get the data of document {doc} on order {id}.
        slots:
          doc: path.DocumentId
          id: path.id
      - text: Download order {id} document {doc}.
        slots:
          id: path.id
          doc: path.DocumentId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Documents/{DocumentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order document
      effect: read
      questions:
      - What are the details of an order document?
      - Can I look up one order document by ID?
      instructions:
      - text: Get document {doc} on order {id}.
        slots:
          doc: path.DocumentId
          id: path.id
      - text: Show order {id} document {doc}.
        slots:
          id: path.id
          doc: path.DocumentId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/BoxPackingList'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's box packing list
      effect: read
      questions:
      - Where do I get the box packing list for an order?
      - Can I view the box packing list for an order?
      instructions:
      - text: Get the box packing list for order {id}.
        slots:
          id: path.id
      - text: Show the box packing list of order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Documents/{DocumentId}/MarkPrinted'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark an order document as printed
      effect: write
      questions:
      - How do I flag a single document on an order as already printed?
      - Which role do I need to mark an order document as printed?
      instructions:
      - text: Mark document {DocumentId} on order {id} as printed.
        slots:
          DocumentId: path.DocumentId
          id: path.id
      - text: Record that document {DocumentId} attached to order {id} has been printed.
        slots:
          DocumentId: path.DocumentId
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Tag'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a tag to an order
      effect: write
      questions:
      - How do I tag an order?
      - Can I add a tag to an order?
      instructions:
      - text: Add tag {tag} to order {id}.
        slots:
          tag: query.Tag
          id: path.id
      - text: Tag order {id} with {tag}.
        slots:
          id: path.id
          tag: query.Tag
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Tag'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from an order
      effect: destructive
      questions:
      - How do I remove a tag from an order?
      - Can I delete a tag on an order?
      instructions:
      - text: Remove tag {tag} from order {id}.
        slots:
          tag: query.Tag
          id: path.id
      - text: Delete the {tag} tag on order {id}.
        slots:
          tag: query.Tag
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Shipments'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipments on an order
      effect: read
      questions:
      - Which parcels have been shipped for an order?
      - Can I see every shipment line on an order?
      instructions:
      - text: List the shipments on order {id}.
        slots:
          id: path.id
      - text: Show all parcels shipped for order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Shipments'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a shipment to an order
      effect: write
      questions:
      - How do I record a tracking number for an order?
      - Can I upload labels for an order's shipment?
      instructions:
      - text: Add a shipment to order {id} with tracking number {Number}.
        slots:
          id: path.id
          Number: requestBody.Number
      - text: Upload labels {Labels} for order {id}.
        slots:
          Labels: requestBody.Labels
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Shipments/{OrderShipmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a shipment from an order
      effect: destructive
      questions:
      - Can I delete one shipment line from an order?
      - What happens to an order when a shipment is removed?
      instructions:
      - text: Delete shipment {OrderShipmentId} from order {id}.
        slots:
          OrderShipmentId: path.OrderShipmentId
          id: path.id
      - text: Remove the parcel line {OrderShipmentId} on order {id}.
        slots:
          OrderShipmentId: path.OrderShipmentId
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Shipments/CreateShipment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a courier shipment for an order
      effect: write
      questions:
      - Can I create a courier shipment for an order through the API?
      - Is it possible to set the number of parcels when creating a shipment?
      instructions:
      - text: Create a courier shipment for order {id}.
        slots:
          id: path.id
      - text: Create a shipment for order {id} with {NumberOfParcels} parcels using courier {CourierServiceId}.
        slots:
          id: path.id
          NumberOfParcels: query.NumberOfParcels
          CourierServiceId: query.CourierServiceId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Shipments/CancelShipment'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a courier shipment for an order
      effect: destructive
      questions:
      - Can I cancel a courier shipment that hasn't been dispatched yet?
      - Does cancelling an order shipment work through the API?
      instructions:
      - text: Cancel the courier shipment for order {id}.
        slots:
          id: path.id
      - text: Cancel the undelivered shipment on order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/ConnectActions'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration actions on an order
      effect: read
      questions:
      - What integration actions have been recorded against an order?
      - Where do I see the connect actions for an order?
      instructions:
      - text: List the integration actions on order {id}.
        slots:
          id: path.id
      - text: Show the connect actions recorded against order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/ConnectActions'].put
  update:
    x-apievangelist-phrasing:
      intent: Add an integration action to an order
      effect: write
      questions:
      - How do I record a new integration action on an order?
      - Can I add a connect action with extra codes and messages?
      instructions:
      - text: Add a {Type} integration action to order {id}.
        slots:
          Type: requestBody.Type
          id: path.id
      - text: Record connect action {Type} on order {id} with messages {Messages}.
        slots:
          Type: requestBody.Type
          id: path.id
          Messages: requestBody.Messages
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock allocations on an order
      effect: read
      questions:
      - Which stock has been allocated to an order?
      - Can I see batch and best-before details for an order's allocations?
      instructions:
      - text: List stock allocations for order {id}.
        slots:
          id: path.id
      - text: Show the batch and BB details allocated to order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/BarcodeVerifiedOrderItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List barcode scan results on an order
      effect: read
      questions:
      - Which items on an order were scanned by barcode?
      - Can I see batch and serial details from barcode scans?
      instructions:
      - text: List barcode scan results for order {id}.
        slots:
          id: path.id
      - text: Show the batch and serial details from barcode scans on order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Queries'].get
  update:
    x-apievangelist-phrasing:
      intent: List queries on an order
      effect: read
      questions:
      - What queries have been raised against an order?
      - Can I see the query history for an order?
      instructions:
      - text: List queries on order {id}.
        slots:
          id: path.id
      - text: Show the query history for order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/Queries/{QueryId}/Comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an order query
      effect: read
      questions:
      - What comments have been left on a query against an order?
      - Can I read the discussion on one order query?
      instructions:
      - text: List comments on query {QueryId} of order {id}.
        slots:
          QueryId: path.QueryId
          id: path.id
      - text: Show the discussion on order {id} query {QueryId}.
        slots:
          id: path.id
          QueryId: path.QueryId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/SplitOrderItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Split order items onto a new order
      effect: write
      questions:
      - Can I split some items off an order onto a separate order?
      - Is it possible to dispatch part of an order separately?
      instructions:
      - text: Split order items from order {id} onto a new order.
        slots:
          id: path.id
      - text: Move selected items off order {id} to a new order.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/BillingAddress'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's billing address
      effect: read
      questions:
      - What billing address is on an order?
      - Can I retrieve the billing address for an order?
      instructions:
      - text: Get the billing address for order {id}.
        slots:
          id: path.id
      - text: Show the billing address on order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Order/{id}/MarkFraudRisk'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark an order as fraud
      effect: write
      questions:
      - How do I flag an order as fraudulent?
      - Can I mark an order as fraud risk?
      instructions:
      - text: Mark order {id} as fraud.
        slots:
          id: path.id
      - text: Flag order {id} as fraudulent.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/mintsoft/overlays/mintsoft-order-api-phrasing-overlay.yaml

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-order-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.