AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Courier API

2 actions 2 updates phrasing extends openapi/aftership-courier-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for AfterShip's API. It is a proposal applied on top of the contract, not a document AfterShip publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/couriers/detect'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Overview Courier API
  version: 1.0.0
extends: openapi/aftership-courier-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/couriers/detect'].post
  update:
    x-apievangelist-phrasing:
      intent: Detect the courier for a tracking number
      effect: read
      questions:
      - Which courier does this tracking number belong to?
      - Can AfterShip guess the carrier from a tracking number's format?
      - Is it possible to narrow courier detection to a few carriers I use?
      instructions:
      - text: Detect the courier for tracking number {tracking_number}.
        slots:
          tracking_number: requestBody.tracking_number
      - text: Figure out which carrier ships {tracking_number} to postal code {destination_postal_code}.
        slots:
          tracking_number: requestBody.tracking_number
          destination_postal_code: requestBody.destination_postal_code
      - text: Check whether {tracking_number} matches courier {slug}.
        slots:
          tracking_number: requestBody.tracking_number
          slug: requestBody.slug
      method: generated
      generated: '2026-09-26'