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.

API URL

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

API request structure

Name	required	Type	Description
CreatedBy	Yes	String	Date of the RMA request
CurrencyCode		String	Code for the RMA currency
MerchantGUID	Yes	String	Unique identifier of the Merchant on Global-e.
MerchantOrderId	No	String	Order unique identifier on the Merchant’s site
OrderId	Yes	String	Global‑e order unique identifier.
ReturnedProducts	Yes	MerchantReturnProduct[]	Array of returned products
ReturnedShippingCosts		Decimal	Cost for return shipping
ReturnTrackingNumber	Yes	String	The return tracking number
RMANumber	Yes	String	RMA unique number
ShipperName	Yes	String	The shipper name
TrackingURL	Yes	String	The return tracking URL
WebStoreCode		String	Code for the web store
WebStoreInstanceCode		String	Code for the web store instance

MerchantReturnProduct

Name	required	Type	Description
SKU	Yes	String	Product SKU
Name	Yes	String	Product name
CartItemId	Yes	String	Product cart item id
ReturnQuantity	Yes	String	Product quantity
ReturnReasonName	Yes	String	Product return reason
MerchantReturnReasonCode	No	String	Merchant return reason code
MerchantReturnReasonName	No	String	Merchant return reason name

API response structure

Name	Type	Description
Success	Bool	Indicates if the call has succeeded. FALSE denotes an error or failure.

API request sample

{
    "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"
}

API response sample

Success example

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

Failure example

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

Method: SendRMAToMerchant

Post MerchantReturn object to the merchant.

We will call this API if we want to send a Global-e RMA number to the merchant.

MerchantAppSetting, SendRMAInfoToMerchantURI must be set to turn on this feature.

ACCEPTS:

MerchantReturn merchantOrder

RETURNS:

Merchant.ResponseInfo class

SAMPLE:

Body:

{
    "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": "3298473298-9238473982"
    "CurrencyCode":"EUR",
    "ReturnShippingCost":2020.9483,
    "WebStoreCode":"Merchant01",
    "WebStoreInstanceCode":"01.webstore.com"
}

Documentation Portal

RMA Notifications (from Global‑e)

SendRMAToMerchant API

Method: SendRMAToMerchant