AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Return Dropoffs API

2 actions 2 updates phrasing extends openapi/aftership-return-dropoffs-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/rma/{rma_number}/dropoffs/{dropoff_id}/drops'].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 Return Dropoffs API
  version: 1.0.0
extends: openapi/aftership-return-dropoffs-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/rma/{rma_number}/dropoffs/{dropoff_id}/drops'].post
  update:
    x-apievangelist-phrasing:
      intent: Record return items dropped off in store
      effect: write
      questions:
      - How do I log that a shopper dropped off return items after scanning their QR code?
      - Can I record the time return items were dropped at a location?
      instructions:
      - text: Record a drop for RMA {rma_number} at dropoff {dropoff_id}.
        slots:
          rma_number: path.rma_number
          dropoff_id: path.dropoff_id
      - text: Log items {items} dropped for RMA {rma_number} dropoff {dropoff_id} at {dropped_at}.
        slots:
          items: requestBody.items
          rma_number: path.rma_number
          dropoff_id: path.dropoff_id
          dropped_at: requestBody.dropped_at
      method: generated
      generated: '2026-09-26'