Returns via API
As part of Global-e's comprehensive solution, Global-e delivers a Returns Portal branded with the merchant logo and theme as well as a unique URL to access your Returns Portal.
Merchants who have their own returns portal and third-party return portals can use Global-e Return APIs to integrate functionality for Global-e return shipping options, as well as to obtain required return documents and manage tracking information.
For further information, please consult the pre-integrated third party returns providers list.
For a new third-party integration please contact your representative at Global-e.
Global-e Return APIs
GetReturnShippingOptions API - Used to receive a list of return shipping methods available for a specific order and its associated costs.
GetReturnDocuments API - Used to receive return documents and related information, including the label, the tracking number, the tracking URL, the shipper’s name, the commercial invoice (if relevant), the RMA number, and the return note.
GetTrackingEvents API - Used to receive status events on the delivery status of an order/return.
High-level flow
Following is the recommended high-level workflow for the product(s) return process.
Shopper initiates a return, usually using an Order ID and an Email.
Shopper selects the return product(s) and the reason(s) for his return.
Returns Portal calls GetReturnShippingOptions AAPI to receive a list of available return shipping methods and their associated prices configured on Global-e.
Returns Portal displays the available return shipping methods.
The return shipping price received from Global-e via the API can be overridden by the Returns Portal.
Additional refund\credit methods, such as store credit, can be offered to the shopper.
Once the shopper selects the desired return shipping method, the Returns Portal calls GetReturnDocuments API to generate a Global-e RMA and receive all the required return documents.
Global-e returns all the required documents as a single PDF file including tracking information, if relevant.
Returns Portal shows a confirmation page indicating the return was issued with the documents available for download.
Global-e sends an RMA email - a return request confirmation email - to the shopper with the relevant documents attached.
The RMA email can be disabled on the Global-e side and managed by the Returns Portal. To disable it please refer to your Global-e representative.
Shopper ships the return package using the return documents.
Optional: the Returns Portal calls the GetTrackingEvents API to get all the tracking events for a given tracking number. (Not all returns are trackable)
Based on the merchant policy, the shopper should be refunded for the returned items (after shipping cost deduction). The merchant portal can use standard Global-e functionality with web portal, pre-integrated webhooks, or Refund APIs.
Integrated Returns Portal
Following is a list of pre-integrated third party returns providers.
Returns Provider | Integrated APIs | Supported Functionalities | Further Information |
|---|---|---|---|
BabackVision | Returns with:
| ||
ChapsVision | Returns with:
| ||
EasyCom | Returns with:
| ||
Loop |
| ||
ParcelLab | Returns with:
|
GetReturnShippingOptions (Merchant to Global-e)
The GetReturnShippingOptions API provides essential return information, including a list of return shipping methods and costs.
Important
Global-e must enable and configure this API on the Global-e side.
GetReturnDocuments (Merchant to Global-e)
Use the GetReturnDocuments API to integrate the return documents capability into your Returns Portal or through a third party returns provider.
Important
Global-e enables and configures this API on the Global-e side.
The API provides return documents and related information, including:
The label
The tracking number
The tracking URL
The shipper's name
The commercial invoice (if relevant)
The return merchandise authorization (RMA) number
The return note
In addition, as part of the process, Global-e produces a Global-e RMA.
If so requested by a merchant, Global-e can configure whether to send RMA letters to customers and whether to disable sending RMA information to the merchant. Electronic invoices are not returned.
Tracking Events API
The Get Tracking Events API lets you receive status events on the delivery status of an order. Reporting of tracking events allows both our customers and 3rd parties to stay informed about the exact location and status of returned items throughout the entire external return journey.
With that, having tracking events for return shipments allows to trigger refunds automatically upon confirmation of returned item receipt (or any other tracking event).
The API accepts one or more order ID numbers, up to 100, on a single call, a list of either orders moved to forward shipments, after checkout completion (outbound), or returns (inbound) and returns their status.
The request can include a list of global-e order IDs, a list of tracking events, or both, but all the same type: Inbound or Outbound. Each request can report on either inbound orders or outbound, but not both. For requesting inbound and outbound tracking events, two different requests should be issued.