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.
overlay: 1.0.0
info:
title: API Evangelist enrichment overlay — Overview Specific Shipper Accounts API
version: 1.0.0
extends: openapi/aftership-specific-shipper-accounts-api-openapi.yml
x-generated: '2026-08-27'
x-method: generated
x-source: apis.yml + conventions/, errors/, rate-limits/, authentication/, lifecycle/ in this repo
actions:
- target: $.info
update:
x-provider: AfterShip
x-provider-id: aftership
x-apis-io: https://apis.io/provider/aftership
x-docs: https://www.aftership.com/docs
x-envelope: '{"meta":{...},"data":{...}} — branch on meta.code, not the HTTP status'
x-error-catalog: errors/aftership-problem-types.yml
x-rate-limits: rate-limits/aftership-rate-limits.yml
x-conventions: conventions/aftership-conventions.yml
x-lifecycle: lifecycle/aftership-lifecycle.yml
x-idempotency: not supported — no Idempotency-Key header on any AfterShip API
x-versioning: date-based path segment (YYYY-MM); as-api-version response header
- target: $.components.securitySchemes
update:
x-additional-methods-documented: AES/HMAC-SHA256 request signing and OAuth 2.0 are documented by AfterShip but
are not expressed in this spec — see authentication/aftership-authentication.yml
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.