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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Overview Cancel Pickups API
version: 1.0.0
extends: openapi/aftership-cancel-pickups-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: 3
- target: $.paths['/cancel-pickups'].get
update:
x-apievangelist-phrasing:
intent: List cancelled carrier pickups
effect: read
questions:
- How do I see every carrier pickup I've cancelled?
- Can I filter cancelled pickups by status or creation date?
instructions:
- text: List my cancelled pickups.
- text: Show cancelled pickups with status {status} created before {created_at_max}.
slots:
status: query.status
created_at_max: query.created_at_max
method: generated
generated: '2026-09-26'
- target: $.paths['/cancel-pickups'].post
update:
x-apievangelist-phrasing:
intent: Cancel a scheduled carrier pickup
effect: destructive
questions:
- How do I cancel a courier pickup I scheduled?
- Can I call off a pickup if the parcels aren't ready?
instructions:
- text: Cancel pickup {pickup}.
slots:
pickup: requestBody.pickup
- text: Call off the scheduled carrier pickup {pickup}.
slots:
pickup: requestBody.pickup
method: generated
generated: '2026-09-26'
- target: $.paths['/cancel-pickups/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one cancelled pickup's details
effect: read
questions:
- What happened to a specific pickup cancellation request?
- Can I fetch a single cancel-pickup record by ID?
instructions:
- text: Show the pickup cancellation record {id}.
slots:
id: path.id
- text: Check whether pickup cancellation {id} went through.
slots:
id: path.id
method: generated
generated: '2026-09-26'
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. See our Privacy Policy and
Terms.