AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Estimated delivery date API

3 actions 3 updates phrasing extends openapi/aftership-estimated-delivery-date-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 3

$.info

$.paths['/estimated-delivery-date/predict'].post

$.paths['/estimated-delivery-date/predict-batch'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Overview Estimated delivery date API
  version: 1.0.0
extends: openapi/aftership-estimated-delivery-date-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: 2
- target: $.paths['/estimated-delivery-date/predict'].post
  update:
    x-apievangelist-phrasing:
      intent: Predict delivery date for one shipment
      effect: read
      questions:
      - When will a package shipped with a given carrier likely arrive?
      - Can I show an estimated delivery date on my product page?
      - Does package weight affect the predicted delivery date?
      instructions:
      - text: Predict the delivery date for {slug} from {origin_address} to {destination_address}.
        slots:
          slug: requestBody.slug
          origin_address: requestBody.origin_address
          destination_address: requestBody.destination_address
      - text: Estimate arrival for a {weight} parcel via {slug} service {service_type_name}.
        slots:
          weight: requestBody.weight
          slug: requestBody.slug
          service_type_name: requestBody.service_type_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/estimated-delivery-date/predict-batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Predict delivery dates for many shipments
      effect: read
      questions:
      - Can I get estimated delivery dates for several shipments in one request?
      - How do I batch delivery date predictions for my whole cart?
      instructions:
      - text: Predict delivery dates in bulk for {estimated_delivery_dates}.
        slots:
          estimated_delivery_dates: requestBody.estimated_delivery_dates
      - text: Run a batch estimated-delivery-date prediction for these shipments.
      method: generated
      generated: '2026-09-26'