> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.bglobale.com/llms.txt
> Use this file to discover all available pages before exploring further.
# RMA Notifications (from Global‑e)
## SendRMAToMerchant API (Global-e to Merchant)
Send Return Merchandise Authorization (RMA) to the merchant. Global‑e calls 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
```
**Parameters**
**Request Parameters**
Request classes [MerchantReturn](/rma-notifications--from-global-e-#UUID-55a27778-b92c-a1df-935e-2deb668fd310_N1744737041352)and [MerchantOrder](/rma-notifications--from-global-e-#UUID-55a27778-b92c-a1df-935e-2deb668fd310_N1744737050671).
| 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` | Array of [MerchantReturnProduct](/objects#merchantreturnproduct-379544) | Array of returned products | Yes |
| `ReturnedShippingCost` | Decimal | Cost for return shipping | |
| `ReturnTrackingNumber` | String | The return tracking number | Yes |
| `RMANumber` | String | Unique RMA 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 |
| -------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `ResponseInfo` | Class ResponseInfo | Indicates if the call has succeeded. Contains the following attributes:
Success
Message
Description |
**Examples**
**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 Examples**
Success Example
```
{
"Success":true,
"Message":"success message",
"Description":"success description"
}
```
Failure Example
```
{
"Success":false,
"Message":"error message",
"Description":"error description"
}
```
### Classes
### Merchant.Order
| Parameter Name | Type | Description | Mandatory |
| ----------------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `AdditionalRequiredDocuments` | List\<[orderDocoment](/endpoints#orderdocument-261905)> | The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment. | |
| `AllowMailsFromMerchant` | Boolean | Indicates if the end customer has opted on the Global‑e checkout page to receive emails from the Merchant.TRUE - Customer opted to receive emailsFALSE - Customer did not opt to receive emails | |
| `CartHash` | String | Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e. | No |
| `CartId` | String | Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for `SendCart` method for the cart converted to this order on Global‑e. | No |
| `CashOnDeliveryFee` | Decimal | Cash On Delivery fee amount in Merchant’s currency. | |
| `CCFPrice` | Decimal | Customs Clearance Fees (CCF), in the Merchant currency. | |
| `ClearCart` | Boolean | Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site.TRUE - The end customer’s cart must be clearedFALSE - The end customer's cart does not have to be cleare | |
| `CurrencyCode` | String | 3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency. | |
| `CurrencyName` | String | Customer currency name. Returned by `GetOrdersDetails` API only | No |
| `Customer` | Class [Merchant.Customer](/endpoints#merchant-customer-261905) | The paying customer’s preferences (Global-e acts as a paying customer). | |
| `CustomerComments` | String | Holds the gift message. In the offline order flow, holds the product comment. | |
| `CustomerComments` | String | Comments text entered by the end customer in Global‑e checkout. | No |
| `CustomerDTBreakdown` | Class [DTBreakdown](/endpoints#dtbreakdown-261905) | Contains the duties and tax parts the customer paid for the order. | No |
| `DateCreated` | String | Order creation date and time. Returned by `GetOrdersDetails` API only. | No |
| `DiscountedShippingPrice` | Decimal | The shipping price paid by the customer converted to the Merchant’s currency. Total Shipping price reducing Order Discounts (`InternationalDetails.DiscountedShippingPrice` price converted to the Merchant currency). | |
| `Discounts` | List\<[Merchant.Discount](/endpoints#merchant-discount-261905)> | The list of discounts being applied to the order, according to the original list of discounts received in `SendCart` for this order, and to the Merchant shipping configuration on Global‑e. | No |
| `DoNotChargeVAT` | Boolean | Indicates if the end customer hasn’t been charged VAT in Global‑e checkout, as specified in the `doNotChargeVAT` argument for the `SendCart` method for the cart converted to this order on Global‑e.TRUE - VAT is not chargedTRUE - VAT is charged | No |
| `ExporterDetails.DestinationRegistrationNumber` | Decimal | The Tax reference number of the GE Entity at the destination country. Should only be provided when the order is tax-collected. Otherwise, the field should be Null. The value should be Null if the order destination is for an EU country. | |
| `ExporterDetails.LocalRegistrationClearance` | Boolean | Indicates whether the Merchant can use the destination Registration number.TRUE - Merchant can use destination Registration number (`ExporterDetails.DestinationRegistrationNumber`)FALSE - Merchant cannot use destination Registration number . | |
| `FreeShippingCouponCode` | String | Merchant’s free shipping `CouponCode` applied by the end customer, as specified in the `FreeShippingCouponCode` argument for the `SendCart` method for the cart converted to this order on Global‑e. | No |
| `InternationalDetails` | Class [Merchant.InternationalDetails](/endpoints#merchant-internationaldetails-261905) | Details referring to the end customer’s order placed on the Global‑e side. These details apply only to the Merchants dealing with international customers’ support themselves. | No |
| `IsB2B` | Boolean | Indicates if the order has a Company name and VAT registration number.TRUE - Order contains a company name and VAT registration numberFALSE - Order does not contain a company name and VAT registration number | |
| `IsFreeShipping` | Boolean | Indicates if the Merchant offers free international shipping to the end customer, as specified in the `IsFreeShipping` argument for the `SendCart` method for the cart converted to this order on Global‑e.TRUE - Shipping is free.FALSE - Shipping is not free. | No |
| `IsMoto` | Boolean | Indicates if the the customer is a customer support agent and an “Offline order” took placeTRUE - The customer is a customer support agent and an “Offline order” took placeFALSE - The customer is a regular customer | |
| `IsReplacementOrder` | Boolean | Indicates if the order is a replacement.TRUE - The order is a replacementFALSE - The order is not a replacement | |
| `IsSplitOrder` | Boolean | Indicates if the order should be handled as a split order (i.e. without consolidation).TRUE - Order will be splitFALSE - Order is not to be split | No |
| `IsTaxExemption` | Boolean | Indicates if the order has a tax exemption.TRUE - Order has a tax exemptionFALSE - Order does not have a tax exemption | |
| `LoyaltyCode` | String | Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout. | No |
| `LoyaltyPointsEarned` | Decimal | The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in the `loyaltyPointsEarned` argument for the `SendCart` method for the cart converted to this order on Global-e. | No |
| `LoyaltyPointsSpent` | Decimal | The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, the “Loyalty points” type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (i.e. on the end user’s My Account page). | No |
| `Markups` | List\<[Merchant.Discount](/endpoints#merchant-discount-261905)> | The list of markups being applied to the order, according to the Merchant shipping configuration on Global‑e. Effectively Markup is a “negative Discount”. The main use case for markups is when the end customer is charged in Global‑e checkout, a flat shipping rate, which is higher than the shipping rate, calculated for the respective order. In this case, Global‑e pays the difference to the Merchant in the form of Markups applied to the order. Unlike Discounts, Markups may be only passed to the Merchant’s back-end ERP system for reconciliation purposes, and may not be displayed to the end customer. | No |
| `MerchantDTBreakdown` | Class [DTBreakdown](/endpoints#dtbreakdown-261905) | Contains the duties and tax parts that the Merchant subsidized for the order. | No |
| `MerchantGUID` | String | Unique identifier of the Merchant on Global-e. | |
| `MerchantOrderId` | String | Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order. | No |
| `ModifiedProduct` | String | Holds the product’s SKU | |
| `OrderCreationSource` | Decimal | One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the [OrderCreationSource Table](/rma-notifications--from-global-e-#UUID-55a27778-b92c-a1df-935e-2deb668fd310_N1736933585508). | |
| `OrderDocuments` | List\<[OrderDocument](/endpoints#orderdocument-261905)> | Always contains a single document - it can be either a VAT Invoice or a Customer Receipt, depends if it is within the EU or not. | |
| `OrderId` | String | Global‑e order unique identifier. | |
| `OrderPaymentMethods` | List\<[OrderPaymentMethod](/endpoints#orderpaymentmethod-261905)> | List of payment methods the customer use (Credit card, Gift Cards) | |
| `OrderStatusReason` | Class [OrderStatusReason](/endpoints#orderstatusreason-261905) | Reason for the order status, why it was cancelled. | |
| `OriginalOrder` | Class [Merchant.OriginalOrder](/endpoints#merchant-originalorder-261905) | Details that refer to the original order if the current order is a replacement. | No |
| `OTCurrencyCode` | String | Currency of the one-time voucher code used to place the order. | No |
| `OTVoucherAmount` | Decimal | The amount taken off the voucher when applicable. | No |
| `OTVoucherCode` | String | One-time voucher code used to place the order | No |
| `Parcels` | List\<[Merchant.Parcel](/endpoints#merchant-parcel-261905)> | The list of parcels created for the order. Returned by `GetOrdersDetails` API only. | No |
| `PaymentDetails` | Class [Merchant.PaymentDetails](/endpoints#merchant-paymentdetails-261905) | The paying customer’s payment details. | |
| `PrePayOffered` | Boolean | Indicates if the prepayment option for duties and taxes was offered to the customer.TRUE - Prepayment option offered.FALSE - Prepayment option not offered. | |
| `PriceCoefficientRate` | Decimal | `CountryCoefficient` rate applied to the prices in this order. | |
| `PrimaryBilling` | Class [Merchant.CustomerDetails](/endpoints#merchant-customerdetails-261905) | The primary customer’s billing details. If `IsEndCustomerPrimary` is set to TRUE, then the primary customer is the payer and his details are indicated in the URL-encoded form. | |
| `PrimaryShipping` | Class [Merchant.CustomerDetails](/endpoints#merchant-customerdetails-261905) | Primary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is TRUE, this field contains the end customers' shipping details. this field contains the Global-e hub's shipping address in the URL-encoded form. | |
| `Products` | List\<[Merchant.Product](/endpoints#merchant-product-261905)> | The list of products being purchased. | |
| `RoundingRate` | Decimal | The average conversion rate applied to the prices paid by the end customer when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors. | |
| `SameDayDispatch` | Boolean | Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout.TRUE - Customer requested "Same Day Dispatch"FALSE - Customer did not request "Same Day Dispatch" | No |
| `SameDayDispatchCost` | Decimal | Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency. | No |
| `SecondaryBilling` | Class [Merchant.CustomerDetails](/endpoints#merchant-customerdetails-261905) | Secondary customer’s billing details. If `Customer.IsEndCustomerPrimary` is FALSE, this contains attributes of the end customer’s details indicated in the URL-encoded form. | |
| `SecondaryShipping` | Class [Merchant.CustomerDetails](/endpoints#merchant-customerdetails-261905) | Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details. | |
| `ShippingMethodCode` | String | Code denoting the local shipping method selected from the list of available shipping options provided in the `shippingOptionsList` argument for the `SendCart` method for the cart converted to this order on Global‑e. | No |
| `ShipToStoreCode` | String | Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side). | No |
| `StatusCode` | String | Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side). | |
| `Subs` | List\<[Merchant.Order](/endpoints#merchant-order-261905)> | Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed. | |
| `TotalDutiesAndTaxesPrice` | Decimal | Total Duties & Taxes value including Customs Clearance Fees, in the Merchant currency. This amount is the total amount, regardless of whether the customer or the Merchant paid it. | |
| `TotalDutiesPaidByCustomerPrice` | Decimal | The total amount of duties paid by the customer in the Merchant’s currency. | |
| `UserId` | String | Internal User identifier on the Merchant’s site originally specified in the `shippingDetails`.`UserId`argument for `SendCart` method for the cart converted to this order on Global‑e. | No |
| `USSalesTax` | Decimal | Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`. | |
| `WebStoreCode` | String | Code used on the Merchant’s side to identify the web store, as specified in the `WebStoreCode` argument for the `SendCart` method for the cart converted to this order on Global‑e. | No |
OrderCreationSource
One of the following possible values of `OrderCreationSource` enumeration denoting a type of discount:
| OrderCreationSource Value | Name | Description |
| ------------------------- | ----------- | ------------------------------------------------------------------------------------------ |
| 0 | GECheckout | The default value for orders created in a normal flow via Global‑e Checkout |
| 1 | Marketplace | The value for orders that are created at a marketplace and sent to Global-e via your brand |
### MerchantReturn
| Parameter Name | Type | Description | Mandatory |
| ---------------------- | --------------------------------------------------------------------- | ------------------------------------------------- | --------- |
| `CreatedBy` | String | Who created the return | |
| `MerchantGUID` | String | Merchant’s unique ID | |
| `MerchantOrderId` | String | Merchant Order Id | |
| `OrderId` | String | Order Id | |
| `ReturnedProducts` | List\<[MerchantReturnProduct](/objects#merchantreturnproduct-379544)> | Products returned | |
| `ReturnShippingCost` | Number | The return shipping fee paid by the end customer. | |
| `ReturnTrackingNumber` | String | Return tracking number | |
| `RMANumber` | String | Return Merchandise Authorization number | |
| `ShipperName` | String | Name of shipper | |
| `TrackingURL` | String | Tracking URL | |
### MerchantReturnProduct
| Parameter Name | Type | Description | Mandatory |
| -------------------------- | ------ | ------------------------------- | --------- |
| `CartItemId` | String | The ID of the cart item | Yes |
| `MerchantReturnReasonCode` | String | Merchant code for return reason | No |
| `MerchantReturnReasonName` | String | Merchant name for return reason | No |
| `Name` | String | Name of product | Yes |
| `ReturnQuantity` | String | Return quantity | Yes |
| `ReturnReasonName` | String | Reason for return | Yes |
| `SKU` | String | Stock keeping unit | Yes |