AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Returns Page API

2 actions 2 updates phrasing extends openapi/aftership-returns-page-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['/returns/link'].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 Returns Page API
  version: 1.0.0
extends: openapi/aftership-returns-page-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['/returns/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pre-filled returns page link
      effect: write
      questions:
      - How do I send a customer a link that opens the returns page with their order filled in?
      - Can I pre-fill the customer's email or postal code in a returns link?
      instructions:
      - text: Create a returns page link for order {order_number}.
        slots:
          order_number: requestBody.order_number
      - text: Generate a returns deep link for order {order_number} and email {customer_email}.
        slots:
          order_number: requestBody.order_number
          customer_email: requestBody.customer_email
      method: generated
      generated: '2026-09-26'