How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AfterShip Cancel Pickups API

The Cancel Pickups API from AfterShip — 2 operation(s) for cancel pickups.

This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://sandbox-api.aftership.com/postmen/v3, https://api.aftership.com/postmen/v3.

3 operations 2 paths 4 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.aftership.com/postmen/v3
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AfterShip Cancel Pickups API declares 1 security scheme for authenticating requests. An API key is passed in the header as as-api-key (as-api-key). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Cancel Pickups 3
GET
/cancel-pickups
Get the cancelled pickups
get-cancel-pickups 6 params → 200
POST
/cancel-pickups
Cancel a pickup
post-cancel-pickups 1 param body → 200
GET
/cancel-pickups/{id}
Get a cancelled pickup
get-cancel-pickup 2 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Cancel_pickup.v3 (5 properties), Meta.v3 (4 properties), Error.v3 (2 properties), Reference.v3 (1 property). Each schema is shown below with its type and property counts.

Cancel_pickup.v3
object
Cancel Pickup object: the description of cancel pickup object
5 properties
Meta.v3
object
Meta data object.
4 properties 2 required
Reference.v3
object
Reference object: the description of reference information
1 property
Error.v3
object
Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a hu…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aftership-cancel-pickups-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of AfterShip Cancel Pickups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.