Skip to main content

Documentation Portal

RMA Notifications (from Global‑e)

SendRMAToMerchant API

Send RMA To Merchant - Global‑e will call this API after a customer generates a label from the return portal.

Supports Shopify’s ability to get the return shipping fee when creating a return in their system.

Method/URL

POST https://www.merchant-site-domain.com/rma-info-to-merchant-url

Request Parameters

Request Parameters

Request classes MerchantReturn and MerchantOrder.

Name

Type

Description

Mandatory

CreatedBy

String

Date of the RMA request

Yes

CurrencyCode

String

Code for the RMA currency

MerchantGUID

String

Unique identifier of the Merchant on Global-e.

Yes

MerchantOrderId

String

Order unique identifier on the Merchant’s site

No

OrderId

String

Global‑e order unique identifier.

Yes

ReturnedProducts

MerchantReturnProduct[]

Array of returned products

Yes

ReturnedShippingCost

Decimal

Cost for return shipping

ReturnTrackingNumber

String

The return tracking number

Yes

RMANumber

String

RMA unique number

Yes

ShipperName

String

The shipper name

Yes

TrackingURL

String

The return tracking URL

Yes

WebStoreCode

String

Code for the web store

WebStoreInstanceCode

String

Code for the web store instance

Response Parameters

Name

Type

Description

Success

Bool

Indicates if the call has succeeded. FALSE denotes an error or failure.

  • Success

  • Message

  • Description

Request Example

Request Example

{
    "OrderId": "GE24192321GB",
    "MerchantOrderId": "71144",
    "RMANumber": "223878",
    "ShipperName": "DHL",
    "ReturnTrackingNumber": "857854854778",
    "TrackingURL": "www.dhl.com/Tracking?TrackingNumber=857854854778",
    "CreatedBy": "Customer",
    "ReturnedProducts": [
        {
            "SKU": "ProductD",
            "Name": "Blue jacket",
            "CartItemId": "2",
            "ReturnQuantity": 1,
            "ReturnReasonName": "Arrived too late",
            "MerchantReturnReasonCode": null,
            "MerchantReturnReasonName": null
        }
    ],
    "MerchantGUID": "7e3d5523-d86a-4c56-8f47-5a48b829e3b7"
    "CurrencyCode":"EUR",
    "ReturnShippingCost":2020.9483,
    "WebStoreCode":"Merchant01",
    "WebStoreInstanceCode":"01.webstore.com"
}

Response Example

Success example

{
    "Success":true,
    "Message":"success message",
    "Description":"success description"
}

Failure example

{
   "Success":false,
   "Message":"error message",
   "Description":"error description"
}
Classes