API Quick Start

This quickstart guide intends to walk you through 3 common scenarios to let you understand how to use AfterShip Returns API.

1. What is AfterShip Returns API (a.k.a AfterShip Returns Management API)?

AfterShip Returns Management API helps you perform admin operations on the returns generated via AfterShip Returns in case there is an enterprise's integration need for their internal system programmatically.

graph TD Ecom(("Orders System/ERP")) CommerceAPI["AfterShip Commerce API"] ReturnsAPI["AfterShip Returns API"] ReturnsWebhook["AfterShip Returns Webhook"] ReturnsCore(("AfterShip System")) Ecom--"1. orders, products, stores"-->CommerceAPI-->ReturnsCore ReturnsCore--"2. RMA Updates"-->ReturnsWebhook-->Ecom Ecom-->ReturnsAPI--"3. Update Status(Optional)"-->ReturnsCore

2. API Endpoint

preparing...

All endpoints are only accessible via HTTPS.

3. Common scenarios

Scenario : Approve a return with a self-provided label

NOTE: You can setup automatic label generations in AfterShip Returns with you own carrier accounts. You don't need to make this call when you enable auto approval. System does the approval for you. Then yo DO NOT need to make this API call. Only if automatic generation doesn't fit your needs, you might consider making use of this API call.

preparing...

Scenario : Resolve a return

preparing...

Scenario : Reject a return

preparing...

Scenario : Mark items received for an RMA

preparing...

Scenario : Tag return items

You need to create a few merchant tags in Returns first. Then inspect the ids from webhooks. Then you can reuse the ids to put tags on an item.

preparing...