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
MerchantGUID	Yes	String	Unique identifier of the Merchant on Global-e.
OrderId	Yes	String	Global‑e order unique identifier.
MerchantOrderId	No	String	Order unique identifier on the Merchant’s site
RMANumber	Yes	String	RMA unique number
ShipperName	Yes	String	The shipper name
ReturnTrackingNumber	Yes	String	The return tracking number
TrackingURL	Yes	String	The return tracking URL
CreatedBy	Yes	String	Date of the RMA request
ReturnedProducts	Yes	MerchantReturnProduct[]	Array of returned products

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	required	Type	Description
InternalOrderId	No* (Optional in case of error, failure or if the action is not related to a specific order)	String	Order unique identifier on the Merchant’s site
OrderId	No	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike InternalOrderId, this identifier is not necessarily unique over time, as the Merchant’s site may potentially reuse it (for example after deleting the old order having the same OrderId).
StatusCode	No* (Optional in case of error or failure)	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).
PaymentCurrencyCode	No	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).
PaymentAmount	No	String	The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call).
Success	Yes	Bool	Indicates if the call has succeeded. FALSE denotes an error or failure.
ErrorCode	No	String	Error code to be returned when an error occurs.
Message	No	String	Optional response message. In case of an error, this property indicates the error message text.
Description	No	String	Optional response description. In case of an error, this property indicates the error message description.

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

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.

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": "7e3d5523-d86a-4c56-8f47-5a48b829e3b7"
}

URL:

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

ACCEPTS:

MerchantReturn merchantOrder

RETURNS:

Merchant.ResponseInfo class

Classes

MerchantReturn

string OrderId
string MerchantOrderId
string RMANumber
string ShipperName
string ReturnTrackingNumber
string TrackingURL
string CreatedBy
List<MerchantReturnProduct> ReturnProducts
string MerchantGUID

MerchantReturnProduct

string SKU
string Name
string CartItemId
string ReturnQuantity
string ReturnReasonName
string MerchantReturnReasonCode
string MerchantReturnReasonName

ResponseInfo

bool Success

Indicates if the respective API method call was successful. Success property value may be only TRUE. Otherwise, ErrorInfo will be returned instead (like in any API method, as described above in this document).

string Reason (optional)

Text that optionally describes the reason for Success status.

Documentation Portal

RMA Notifications (from Global‑e)

SendRMAToMerchant API

Method: SendRMAToMerchant

Classes