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 Returns API

Create, approve, reject, resolve and receive returns by return ID or RMA number, manage return items, item tags and returns-page deep links.

This API exposes 16 operations across 15 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 2026-07.

Requests are made against a single base URL, https://api.aftership.com/returns/2026-07.

16 operations 15 paths 22 schemas 3 GET13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-07
Base URL
https://api.aftership.com/returns/2026-07
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AfterShip Returns 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 16

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

Returns 16
GET
/returns/{return_id}
Get return detail by ID
get-returns-return_id 1 param → 200
GET
/returns/rma/{rma_number}
Get return detail by RMA number
get-returns-rma-rma_number 1 param body → 200
GET
/returns
Get returns
get-returns 9 params → 200
POST
/returns
Create Return
post-returns body → 201422429
POST
/returns/rma/{rma_number}/approve
Approve Return By RMA number
post-returns-rma-rma_number-approve 1 param body → 202404409422
POST
/returns/{return_id}/approve
Approve Return By Return ID
post-returns-return_id-approve 1 param body → 202
POST
/returns/rma/{rma_number}/resolve
Resolve Return By RMA number
post-returns-rma-rma_number-resolve 1 param body → 200404409
POST
/returns/{return_id}/resolve
Resolve Return By Return ID
post-returns-return_id-resolve 1 param body → 200404409
POST
/returns/rma/{rma_number}/reject
Reject Return By RMA number
post-returns-rma-rma_number-reject 1 param body → 200404409422
POST
/returns/{return_id}/reject
Reject Return By Return ID
post-returns-return_id-reject 1 param body → 200404409422
POST
/returns/rma/{rma_number}/receive-items
Receive items by RMA number
post-returns-rma-rma_number-receive-items 1 param body → 200404422
POST
/returns/{return_id}/receive-items
Receive items by Return ID
post-returns-return_id-receive-items 1 param body → 200404422
POST
/returns/rma/{rma_number}/attach-shipments
Attach shipments by RMA number
post-returns-rma-rma_number-attach-shipments 1 param body → 200404422
POST
/returns/{return_id}/attach-shipments
Attach shipments by Return ID
post-returns-return_id-attach-shipments 1 param body → 200404422
POST
/returns/{return_id}/remove-items
Remove return items by Return ID
post-returns-return_id-remove-items 2 params body → 200404422
POST
/returns/rma/{rma_number}/remove-items
Remove return items by RMA number
post-returns-rma-rma_number-remove-items 2 params body → 200404422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Return (42 properties), Return_item (32 properties), Return_shipment (16 properties), Address (10 properties). Each schema is shown below with its type and property counts.

Return_shipment
object
16 properties
Instant_exchange
object
2 properties
Order
object
8 properties
Pagination
object
4 properties
Receiving
object
3 properties
Return_item
object
32 properties
Refund
object
7 properties
Item_tag
object
3 properties
Restock
object
1 property
Return_method
object
4 properties
Dropoff_shipment
object
5 properties
Meta_20200
object
Meta data object.
3 properties 3 required
Meta
object
4 properties
Meta_20000
object
Meta data object.
3 properties 3 required
Cost_of_return
object
2 properties
Money
object
2 properties
Meta_20100
object
Meta data object.
3 properties 3 required
Exchange
object
7 properties
Dropoff
object
8 properties
Error
object
Error detail 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 locatio…
2 properties
Address
object
10 properties 6 required
Return
object
[url](/docs/enum/platforms.md)
42 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

This is an independent, third-party profile of AfterShip Returns 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.