If Glopal Returns are enabled for the store, buyer can access merchant branded portal managed by Glopal to request returns for eligible orders and items.

Return can be observed in following statuses:

API integration

Use Glopal Order API to integrate with returns feature.

There are two elements of the API integration:

  1. Pulling new events to be notified of new return requests and updates

  2. Getting return request details from the order details

Please refer to the Order API integration guide for information on how to setup recurring task (eg. cronjob) to pull new events from Glopal. You can adjust to pull one or or more event types you are interested to process.

New return request triggers return.requested event. In the event, field order_id contains Glopal Order ID and field entity_id contains Glopal Return Request ID.

  "event_id": "47CE0V5XR9CAWJ2Y",
  "event_name": "return.requested",
  "event_at": "2023-01-10T10:00:00.000Z",
  "order_id": "3S7Z7N5X-Q4PSJMC1",
  "external": {
    "order_id": "92",
    "order_number": "00092"
  "entity_id": "4"

To get return request details, use Order API to retrieve order details first, then locate the related return in the returns top level key, matching by ID (returns[].id = entity_id).

Glopal will process all incoming requests and once return label and tracking number is ready, return will be marked as authorized. This triggers return.authorized event, with the same structure as the previous event. Receiving this event, retrieve the latest order details to get return carrier and tracking info. RMA ID can be used to pull tracking information from the Glopal WS API.

Return request can be cancelled at any time before package is registered in the carrier network, triggering return.cancelled event.

Read more about Order API and Event webhooks.

Merchant Account

Requested returns can also be accessed in the Merchant Account user interface.

Last updated