Return Methods

GetReturnShippingOptions (Merchant to Global-e)

The Return Shipping Options API provides essential return information, including a list of return shipping methods and costs.

Important

Global-e must enable and configure this API on the Global-e side.

Method/URL

POST https://{globale_api_domain}/Return/GetReturnShippingOptions

Parameters

Request

Parameter Name	Type	Description	Mandatory
`CultureCode`	String	10-character code. Default is EN Maximum: 10 characters.	No
`CurrencyCode`	String	The currency of the return prepaid shipping cost. This is a 3-char ISO currency code. The default should be the same as the origin order currency. If the submitted order currency is not the same as the (outbound) order, apply the currency exchange.	No
`Email`	String	Email that identifies the source of the request.	No
`OrderId`	String	Unique Global-e Order ID or Merchant Order ID. Maximum: 100 characters.	Yes
`ProviderCode`	String	Provider name that identifies the source of the request.	Yes
`ReturnedProducts`	Array of `Products`	The following fields should be populated: `ProductCode` `CartItemID` `ReturnQuantity`	Yes
`ReturnShippingMethodId`	Long	Provides the ID of the return shipping method.	No

Products

Parameter Name	Type	Description	Mandatory
`Attributes`	Object `Attributes`	The attributes of the product. Includes the following fields: AttributeCode Name AttributeTypeCode
`BillingDetails`	Object `BillingDetails`	Provides billing details for the products.
`Brand`	Object `Brand`	The product’s brand. Includes the following fields: BrandCode – string – Up to 50 chars Name – string – Up to 100 chars.	No
`CartItemId`	String	identifier of the cart item on the Merchant’s site. This property may be optionally specified in the SendCart API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API. Max length: 50 chars.	No
`CartItemOptionId`	String	Identifier of the child cart item “option” on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (CartItemId must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a package for the parent item in the same cart. This property may be optionally specified in the SendCart API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API. Max length: 50 chars.	No
`Categories`	Object `Category`	The category of the product. Includes the following: CategoryCode – sting – Up to 50 chars. Name
`DeliveryQuantity`	Decimal	The quantity set for delivery for the product (to be used in the Order APIs described below, as needed).	No
`Description`	String	Description of the Product. Length: Unlimited.	Yes
`DiscountsList`	Object `DiscountsList`	List of possible discounts for products.
`GenericHSCode`	String	The product’s generic HS Code (not country-specific). If specified this property may assist in mapping the product for duties and tax calculation purposes. Max length: 50 chars.	No
`Height`	Decimal	The product’s height in the Merchant’s default unit of length measure (will be converted to CM).	No
`ImageHeight`	Decimal	The product’s image height in pixels	No
`ImageURL`	String	The product’s image URL A JPG formatted image. Max length: 255 chars.	No
`ImageWidth`	Decimal	The product’s image width in pixels	No
`IsBlockedForGlobalE`	Boolean	Indicates if product is available/blocked for international shipping. TRUE - Product is blocked for international shipping. FALSE - Product is available for international shipping.	No
`IsFixedPrice`	Boolean	Indicates if the product’s price is fixed by the Merchant. TRUE - Product’s price is fixed by the Merchant, in the default currency for the country. In this case, all price modifications are disabled for this product. Setting fixed prices is only allowed for the Countries where the `SupportsFixedPrices` flag is set to TRUE. FALSE - Product price is not fixed.	No
`Keywords`	String	The product’s keywords. Length: Unlimited.	No
`Length`	Decimal	The product’s length in the Merchant’s default unit of length measure (will be converted to CM).	No
`ListPrice`	Decimal	Product list price (before discounts) as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling.	No
`LocalVATRateType`	Object `VATRateType`	If `UseCountryVAT` for the current Country is TRUE, the `VATRateType` denotes the VAT for the target country. This value must be specified if the order was placed by a local customer. Includes the following fields: `VATRateTypeCode` Rate	No
`OrderedQuantity`	Decimal	Ordered quantity for the product (to be used in Checkout / Order APIs described below, as needed)	No
`OriginalListPrice`	Decimal	Product list price (before any discounts) in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` value for the end customer’s current country.	No
`OriginalSalePrice`	Decimal	Product sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` value for the end customer’s current country.	No
`OriginCountryCode`	String	2-char ISO country code of the product’s country of Origin. The Merchant’s country will be assumed if not specified.	No
`ParentCartItemId`	String	Identifier of the current item’s parent cart item on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (CartItemId must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a custom option (such as a product package) for the parent item in the same cart. This property may be optionally specified in the SendCart API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API. Max length: 50 chars.	No
`ProductCode`	String	SKU code used to identify the product on the Merchant site (to be mapped on the Global-e side). Max length: 100 chars.	Yes
`ProductGroupCode`	String	The product’s group code is on the merchant’s site (to be mapped on the global-e side). Usually, this value is a part of the product SKU code denoting a group of similar products (such as "the same product in different colors"). Max length: 300 chars.	No
`SalePriceBeforeRounding`	Decimal	Product sale price as displayed to the customer, after applying country coefficient, FX conversion, and IncludeVAT handling, before rounding rules have been applied. If not specified, will be deemed equal to SalePrice.	No
`SalePrice`	Decimal	Product sale price as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT.	No
`ShippingDetails`	Object `ShippingDetails`	Shipping details for the product.
`URL`	String	The product’s information page URL. Max length: 255 chars.	No
`UseCountryVAT`	Boolean	Identifies if the `LocalVATRateType` must be specified. TRUE - Must specify `LocalVATRateType` FALSE - Do not need to set `LocalVATRateType`
`Volume`	Decimal	The product’s volume in the Merchant’s default unit of volume measure (will be converted to cubic CM).	No
`Weight`	Decimal	The product’s weight is in the Merchant’s default unit of weight measure (will be converted to grams). The merchant’s default product weight will be used if not specified	No
`Width`	Decimal	The product’s width is measured in the merchant’s default unit of length (will be converted to CM).	No
`VATRateType`	String	Product’s VAT rate type or class. Max length: 100 chars.	No

Attributes

Parameter Name	Type	Description
`AttributeCode`	String	Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)
`AttributeTypeCode`	String	Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side)
`Name`	String	Attribute name

BillingDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1. Length: Unlimited.	No
`Address2`	String	Address line 2. Length: Unlimited.	No
`City`	String	City name. Max length: 500 chars.	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name. Max length: 255 chars.	No
`Email`	String	E-mail address. Max length: 500 chars.	No
`Fax`	String	Fax number. Max length: 250 chars.	No
`FirstName`	String	Customer’s first name. Max length: 40 chars. No length validation. The rest will be truncated.	No
`LastName`	String	Customer’s last name. Max length: 40 chars. No length validation. The rest will be truncated.	No
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	No
`Phone1`	String	Phone #1. Max length: 250 chars.	No
`Phone2`	String	Phone #2. Max length: 250 chars.	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvince`	String	State or province name. Max length: 500 chars.	No
`UserIdNumber`	String	User’s personal ID document number	No
`UserIdNumberType`	Object `UserIdNumberType`	User’s personal ID document type. Includes the following fields: `UserIdNumberTypeCode` `Name`	No
`UserId`	String	Internal User identifier on the Merchant site	No
`Zip`	String	Zip or postal code. Max length: 250 chars.	No

UserIdNumberType

Parameter Name	Type	Description	Mandatory
`Name`	String	Identification document type name
`UserIdNumberTypeCode`	String	Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side)

Parameter Name	Type	Description	Mandatory
`BrandCode`	String	Brand code on the Merchant’s site (to be mapped on the Global‑e side)
`Name`	String	Brand name

Parameter Name	Type	Description	Mandatory
`CategoryCode`	String	Category code on the Merchant site (to be mapped on the Global‑e side)
`Name`	String	Category name

DiscountsList

Parameter Name	Type	Description	Mandatory
`CouponCode`	String	Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only)	No
`Description`	String	Discount textual description. Length: unlimited.	No
`DiscountCode`	String	Discount code used to identify the discount on the Merchant’s site. This property may be optionally specified in the `SendCart` API only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` API.	No
`DiscountType`	Decimal	One of the following possible values of `DiscountTypeOptions` enumeration denoting a type of discount: Cart discount Shipping discount Loyalty points discount Duties discount Checkout Loyalty points discount Payment charge
`Name`	String	Discount name. Length: unlimited.	Yes
`OriginalDiscountValue`	Currency	Discount value in original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country. Max length: 18,4.	Yes
`ProductCartItemId`	String	Identifier of the product cart item related to this discount on the Merchant’s site. This property may be optionally specified in the `SendCart` API only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` API. Max length: 50 chars.	No

ShippingDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1. Unlimited length.	No
`Address2`	String	Address line 2. Unlimited length.	No
`City`	String	City name. Max length: 500 chars.	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name. Max length: 255 chars.	No
`Email`	String	E-mail address. Max length: 500 chars.	No
`Fax`	String	Fax number. Max length: 250 chars.	No
`FirstName`	String	First name. Max length: 40 chars. No length validation. The rest will be truncated.	No
`LastName`	String	Last name. Max length:40 chars. No length validation. The rest will be truncated.	No
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	No
`Phone1`	String	Phone #1. Max length: 250 chars.	No
`Phone2`	String	Phone #2. Max length: 250 chars.	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable). 2 chars.	No
`StateOrProvince`	String	State or province name. Max length: 500 chars.	No
`UserId`	Decimal	Internal User identifier on the Merchant site	No
`UserIdNumber`	String	User’s personal ID document number	No
`UserIdNumberType`	String	User’s personal ID document type (e.g. Passport, ID card, etc.)	No
`Zip`	String	Zip or postal code. Max length: 250 chars.	No

VATRateType

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT rate type name	No
`Rate`	Decimal	VAT rate decimal value
`VATRateTypeCode`	String	VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)

Response

Parameter Name	Type	Description	Mandatory
`Cost`	Double	The cost of the shipment	Yes
`Currency`	String	3-letter currency ISO code	Yes
`IsQrLabel`	String	Whether this is a label-free return (QR code only).	No
`isTrackable`	String	Identifies whether this is a trackable return.	Yes
`MerchantOrderId`	String	The unique merchant Order ID. Maximum: 100 characters	Yes
`OrderId`	String	The unique Global-e Order ID. Maximum: 100 characters	Yes
`ReturnShippingDestinationDetails`	Object `ReturnShippingDestinationDetails`	The `ReturnShippingDestinationDetails` object contains all relevant details of the return destination. Contains the following values: `Address` (Mandatory) `City` (Mandatory) `Country` (Mandatory) `Email` (Optional) `Phone` (Optional) `State` or `Province` (Optional) `Zip` (Mandatory)	Yes
`ReturnShippingMethods`	Array of `ReturnShippingMethods`	`ReturnShippingMethods` describes the available return shipping option for the requested items.	Yes
`ShippingMethodDescription`	String	Description of the shipping method.	Yes
`ShippingMethodId`	Integer	The shipping method identifier. Can be used when calling GetReturnDocuments to receive the return document for the selected shipping method.GetReturnDocuments	Yes
`ShippingMethodType`	String	Identifies the shipping method type.	Yes
`ShippingMethodTypeId`	Integer	Possible values: Self-postage (standard) Prepaid Local Prepaid Courier Local Prepaid Consolidated Can be used when calling GetReturnDocuments to receive the return document for the selected shipping method.	Yes
`ShipperName`	String	The name of the shipping service of the return provider	Yes

ReturnShippingDestinationDetails

Field	Type	Description	Mandatory
`Address`	String	Address for return shipping	Yes
`City`	String	City for return shipping	Yes
`Country`	String	Country for return shipping	Yes
`Email`	String	Email for for return shipping	No
`Phone`	String	Phone for return shipping	No
`Province`	String	Province for return shipping	No
`State`	String	State for return shipping	No
`Zip`	String	Zip for return shipping	Yes

ReturnShippingMethods

Parameter Name	Type	Description	Mandatory
`Cost`	Decimal	Shipment cost.
`Currency`	String	Currency used for shipment cost.
`IsQrLabel`	String	Whether this is a label-free return (QR code only).	No
`IsTrackabe`	Boolean	True for supported by Global-e for tracking capabilities and tracking events. False for carriers that Global‑e does not support tracking capabilities
`ReturnShippingTypeId`	Number	Possible values: 1 - Self-postage (standard) 2 - Prepaid 3 - Local Prepaid Courier 4 - Local Prepaid 5 - Consolidated
`ShipperName`	String	Name of the shipper sending the parcel.
`ShippingMethodDescription`	String	A description of the shipment method used to send the parcel.
`ShippingMethodId`	String	The identifier for the shipment method used to send the parcel.
`ShippingMethodType`	String	The shipping method type used to send the parcel.

Errors

General Error Response

{
       "Code": "error code",
       "Error": "error message",
       "Description: "error description"
}

Error Codes

Code	Message
E01	Could not find an available shipping method (No shipping method was found for the submitted products and quantities)
E02	Return is not allowed due to order status %`Order Status`% (Relates to Allowed Return Statuses)
E03	Order ID not found (Returned if the provided OrderId cannot be found for the merchant)
E04	Currency is not valid
E05	There are multiple orders with this `orderID` %`orderID`%
E06	The `ReturnShippingMethodId` %`ReturnShippingMethodId`% is not valid
ME01	Input value for `ProductCode` is not valid
ME02	Input value for `CartItemId` is not valid
ME03	Input value for `ReturnQuantity` is not valid
ME06	Input value for `OrderId` is not valid
ME07	Input value for `Email` is not valid
ME09	Input value for `ReturnedProducts` is not valid
ME10	Input value for `CultureCode` is not valid
ME12	Input value for `CurrencyCode` is not valid
ME13	Input value for `ProviderCode` is not valid
SME15	Input value for `ReturnShippingMethodId` is not valid

Product Errors

Code	Message
PE01	Unable to process this request as the returns period has expired for product %`Product`% (Global-e can enable the PE01 error, and whether to enable validation for expired return periods, through configuration)
PE02	Return product %`Product`% was not found for order
PE03	Product %`Product`% is not returnable
PE04	Requested return product quantity was not delivered to customer %`Customer`%
PE05	Requested return product is virtual ({0})
PE06	Requested return product contains dangerous goods ({0})
PE07	Requested return product quantity is zero ({0})
PE08	OrderProduct was not found for requested return product ({0})
PE09	Child return product was requested without parent product ({0})
PE10	Order product delivery quantity is zero ({0})
PE11	Order product unit sale price is zero ({0})
PE13	Return products collection has duplication
PE14	Return products collection is empty

Examples

Examples

Request

{
     "ProviderCode": "ExampleProvider",
     "OrderId": "EUQA6215359",
     "Email": [email protected],
     "ReturnedProducts": [
         {
             "ProductCode": "433117270672",
             "ReturnQuantity": 1
          }
     ]
 }

Response

{
     "IsSuccess": true,
     "Data": {
         "OrderId": "GE10470948238NL",
         "MerchantOrderId": "EUQA6215359",
         "ReturnShippingMethods": [
             {
                 "ShippingMethodId": 40044878,
                 "ShippingMethodDescription": "DHL-GlobalE",
                 "ShippingMethodType": "Express Courier (Air)",
                 "ShippingMethodTypeID": 2,
	         "ShipperName": "DHL",
                 "IsQrLabel": false,
                 "IsTrackable": true,
                 "Cost": 0.0,
                 "Currency": "EUR"
             }
         ],
         "ReturnShippingDestinationDetails": {
             "Country": "Netherlands",
             "City": "Amsterdam",
             "Address": "Ood 5",
             "Zip": "4751XK",
             "StateOrProvince": "",
             "Email": [email protected],
             "Phone": "310610887191"
         }
     }

GetReturnDocuments (Merchant to Global-e)

Use the GetReturnDocuments API to integrate the return documents capability into your Returns Portal or through a third party returns provider.

Important

Global-e enables and configures this API on the Global-e side.

The API provides return documents and related information, including:

The label
The tracking number
The tracking URL
The shipper's name
The commercial invoice (if relevant)
The return merchandise authorization (RMA) number
The return note

In addition, as part of the process, Global-e produces a Global-e RMA.

If so requested by a merchant, Global-e can configure whether to send RMA letters to customers and whether to disable sending RMA information to the merchant. Electronic invoices are not returned.

Method/URL

POST https://{globale_api_domain}/Return/GetReturnDocuments

Parameters

Request

Field	Type	Description	Mandatory
`CurrencyCode`	String	The currency of the returned prepaid shipping cost. 3-character ISO code.	Mandatory if ShippingCost has a greater value than 0.
`CultureCode`	String	The language for the Return Note document. 3-character ISO code. Currently, English is the only supported language.	No
`Email`	String	The customer's email address. Maximum 100 characters.	No
`IsReturnForService`	Boolean	Indicates if return is created for service	No
`MerchantRMANumber`	String	The Merchant's internal return merchandise authorization (RMA) Number. Maximum 200 characters.	No
`OrderId`	String	Then unique Order ID. Maximum 100 characters.	Yes
`ProviderCode`	String	The provider's name identifies the source of the request.	Yes
`ReturnAddress`	Object `ReturnAddress`	The merchant hub delivery address with return details.	No
`ReturnedProducts`	Array	An array containing the returned products' details. Contains array of ReturnedProduct objects: CartItemID MerchantReturnReasonCode MerchantReturnReasonDescription ProductCode ReturnQuantity	Yes
`ReturnShippingMethodId`	Integer	Based on the end customer's selected shipping method, as returned in the Get Return Shipping Options response. If empty, Global-e uses the cheapest method based on the return shipping type ID (or self-postage if configured)	No
`ReturnShippingTypeId`	Integer	Possible values: Self postage (standard) Prepaid Local Prepaid Courier Local Prepaid Consolidated	No
`ShippingCost`	Decimal	The prepaid shipping cost associated with the return. If not provided, then the ShippingCost will be the configured prepaid/flat return rate.	No

ReturnAddress

Field	Type	Description	Mandatory
Address1	String	Address line 1 for return	Yes
Address2	String	Address line 2 for return	No
City	String	City name for return. Maximum 100 characters.	Yes
CompanyName	String	Company name for return. Maximum 100 characters.	Yes
CountryCode	String	Country code for return, 2-character code	Yes
Email	String	Email address for return. Maximum 500 characters.	No
Fax	String	Fax number for return. Maximum 50 characters.	No
FirstName	String	First name for return. Maximum 500 characters.	Yes
LastName	String	Last name for return. Maximum 500 characters.	No
Phone1	String	Phone 1 for return. Maximum 50 characters.	No
Phone2	String	Phone 2 for return. Maximum 50 characters.	No
PostalCode	String	Postal code for return. Maximum 50 characters.	Yes
StateCode	String	State code for return. Maximum 20 characters.	No
StateOrProvince	String	State or province for return. Maximum 100 characters.	No

ReturnedProduct

Parameter Name	Type	Description	Mandatory
`CartItemId`	String	Identifier of the cart item. Maximum 50 characters.	No
`MerchantReturnReasonCode`	String	The code of the reason for the product return on the merchant. Maximum 100 characters.	No
`MerchantReturnReasonDescription`	String	The description of the reason for the return on the merchant site. Maximum 100 characters.	No
`ProductCode`	String	The ProductCode identifying the product. Maximum 600 characters.	Yes
`ReturnQuantity`	Integer	Quantity of the returned product. Maximum 100 characters.	Yes

Response

When the API call is successful, the call returns the documents required for the return process.

Name	Type	Description
`IsSuccess`	Boolean	True: If the API call is successful. False: If the API call fails.
`Data`	Object `Data`	Data regarding the return, including: GlobalRMANumber (String, Max 100 chars) MerchantOrderId (String, Max 100 chars) MerchantRMANumber (String, Max 100 chars) OrderId (String, Max 100 chars) ReturnDocuments, array containing: DocumentData DocumentTypeCode DocumentTypeName URL ReturnTrackingDetails, array containing: IsQrLabel IsTrackable ShipperName TrackingNumber TrackingURL

Name

Type

Description

IsSuccess

Boolean

True: If the API call is successful.

False: If the API call fails.

Data

Object Data

Data regarding the return, including:

GlobalRMANumber (String, Max 100 chars)
MerchantOrderId (String, Max 100 chars)
MerchantRMANumber (String, Max 100 chars)
OrderId (String, Max 100 chars)
ReturnDocuments, array containing:
- DocumentData
- DocumentTypeCode
- DocumentTypeName
- URL
ReturnTrackingDetails, array containing:
- IsQrLabel
- IsTrackable
- ShipperName
- TrackingNumber
- TrackingURL

Data

Parameter Name	Type	Description
`GlobaleRMANumber`	String	The Global-e return merchandise authorization (RMA) Number. Maximum 100 characters.
`MerchantOrderId`	String	The Merchant Order ID. Maximum 100 characters.
`MerchantRMANumber`	String	The Merchant RMA Number Maximum 100 characters.
`OrderId`	String	The Global-e Order ID. Maximum 100 characters.
`ReturnDocuments`	Object `ReturnDocuments`	Object `ReturnDocuments` provides documents associated with returns. `ReturnDocuments` returns the following documents individually or unified, as a single multi-page document, including: Commercial Invoice (if the electronic invoice is not supported) Shipping Label Return Note
`ReturnTrackingDetails`	Object `ReturnTrackingDetails`	Object `ReturnTrackingDetails` contains tracking details for returns.

ReturnDocuments

The ReturnDocuments returns the following documents individually or unified, as a single multi-page document, including:

Commercial Invoice (if the electronic invoice is not supported)
Shipping Label
Return Note

Parameter Name	Type	Description
`DocumentData`	String	Base64 file type representing the document file content
`DocumentTypeCode`	String	The code value of the document type. This value can be: ShippingLabel ReturnNote CommercialInvoice CombinedReturnDocuments (if UnifiedAllDocumentsUnderOneFile = true) Each document contains the relevant content and with relevant copies. Examples: The return note PDF has only the return note without additional documents. The ReturnCommercialInvoice should have the return commercial invoice with the correct number of copies.
`DocumentTypeName`	String	The name of the document type, e.g. ShippingLabel, ReturnNote or CommercialInvoice (unless the invoice is electronic, no invoice is returned).
`URL`	String	URL of the document

ReturnTrackingDetails

Parameter Name	Type	Description	Mandatory
`IsQrLabel`	String	Identifies whether this is a label-free return (QR code only). This information also applied to the ShippingLabel object	No
`IsTrackable`	String	Identifies whether this is a trackable return	No
`ShipperName`	String	The name of the Shipping Service of the return provider	Yes
`TrackingNumber`	String	Reference number for the tracking service used by the shipper for this return	Yes
`TrackingURL`	String	Tracking URL of the tracking service site used by the shipper	Yes

Errors

Error Codes

Code	Message
E01	Could not create the shipping label. (Note: Not applicable to the self-postage option.)
E02	The return is not allowed due to the order status ({0}) (Global-e can enable the E02 error code and validate the order status through configuration.)
E03	The Order ID was not found
E04	There is already an RMA request for this order ({0})
E07	The return is not allowed due to the parcel status ({0}).
E08	Unable to find the shipping method for the provided return shipping method Id ({0})
E09	The provided `ReturnShippingTypeId` is not valid ({0})
E10	There are multiple orders with this Order ID ({0})
E11	No shipping options were found for the order return ({0})
E12	The return shipping address was not found for order ({0})
E13	Invalid currency code for the provided shipping cost for order ({0})
E14	The return shipping cost cannot be a negative number
E15	The return shipping cost is greater than the return product price
E16	Return address country code is not valid
E17	Return address state code is not valid or does not belong to the country `ReturnAddressStateIsNotValid`
E18	Return address country is not allowed for given order `ReturnAddressCountryIsNotAllowed`
E19	`MerchantRMANumber` is required
E20	`ReturnShippingMethodId` is required for provider ({0})

Product Errors

Code	Message
PE01	Unable to process this request as the returns period has expired for product %`Product`% (Global-e can enable the PE01 error, and whether to enable validation for expired return periods, through configuration)
PE02	Return product %`Product`% was not found for order
PE03	Product %`Product`% is not returnable
PE04	Requested return product quantity was not delivered to customer %`Customer`%
PE05	Requested return product is virtual ({0})
PE06	Requested return product contains dangerous goods ({0})
PE07	Requested return product quantity is zero ({0})
PE08	OrderProduct was not found for requested return product ({0})
PE09	Child return product was requested without parent product ({0})
PE10	Order product delivery quantity is zero ({0})
PE11	Order product unit sale price is zero ({0})
PE13	Return products collection has duplication
PE14	Return products collection is empty

Model Validation Errors

Code	Message
ME01	The input value for `ProductCode` is Invalid
ME02	The input value for `CartItemId` is Invalid
ME03	The input value for `ReturnQuantity` is Invalid
ME04	The input value for `MerchantReturnReasonCode` is Invalid
ME05	The input value for `MerchantReturnReasonDescription` is Invalid
ME06	The input value for `OrderId` is Invalid
ME07	The input value for `Email` is Invalid
ME08	The input value for `ReturnShippingTypeId` is Invalid
ME09	The input value for `ReturnedProducts` is Invalid
ME10	The input value for `CultureCode` is Invalid
ME11	The input value for `MerchantRMANumber` is Invalid
ME12	The input value for `CurrencyCode` is Invalid
ME13	The input value for `ProviderCode` is Invalid
ME14	The input value for `ShippingCost` is Invalid
ME15	The input value for `ReturnShippingMethodId` is Invalid
ME16	"Input value for `ReturnAddress.CompanyName` is required"
ME17	Input value for `ReturnAddress.FirstName` is required
ME19	Input value for `ReturnAddress.City` is required
ME20	Input value for `ReturnAddress.PostalCode` is required
ME21	Input value for `ReturnAddress.CountryCode` is required
ME22	Input value for `ReturnAddress.CompanyName` exceeds the 100-character limit
ME23	Input value for `ReturnAddress.FirstName` exceeds the 500-character limit
ME24	Input value for `ReturnAddress.LastName` exceeds the 500-character limit
ME25	Input value for `ReturnAddress.Email` exceeds the 500-character limit
ME26	Input value for `ReturnAddress.Phone1` exceeds the 50-character limit
ME27	Input value for `ReturnAddress.Phone2` exceeds the 50-character limit
ME28	Input value for `ReturnAddress.Fax` exceeds the 50-character limit
ME29	Input value for `ReturnAddress.City` exceeds the 100-character limit
ME30	Input value for `ReturnAddress.StateOrProvince` exceeds the 100-character limit
ME31	Input value for `ReturnAddress.StateCode` exceeds the 10-character limit
ME32	Input value for `ReturnAddress.PostalCode` exceeds the 50-character limit
ME33	Input value for `ReturnAddress.CountryCode` exceeds the 2-character limit

Examples

Request

curl --location 'https://[globale domain]/Return/GetReturnDocuments' \
 --header 'MerchantGUID: D2ED2A7F-F6ED-4CCB-B611-B44AC8D02250' \
 --header 'Content-Type: application/json' \
 --data-raw '{ "ProviderCode": "Loop",
   "OrderId": "GE314856569TS",
   "Email": "[email protected]",
   "MerchantRMANumber": "RM132",
   "ShippingCost": 10.0,
   "CurrencyCode": "USD",
   "ReturnShippingTypeId": 2,
   "ReturnShippingMethodId": null,
   "ReturnedProducts": [
      {
       "ProductCode": "DKB500680.M8",
       "CartItemId": null,
       "ReturnQuantity": 1,
       "MerchantReturnReasonCode": "",
       "MerchantReturnReasonDescription": "Return Reason from GRD request for product 1"
     },
     {
       "ProductCode": "B7ECS.C8",
       "CartItemId": 1,
       "ReturnQuantity": 1,
       "MerchantReturnReasonCode": "TTT",
       "MerchantReturnReasonDescription": "Return Reason from GRD request for product 2"
     }
   ]
 }'

Responses

Success

{
   "IsSuccess": true,
 "Data": {
    "OrderId": "GE314856569TS", 
        "MerchantOrderId": "314856569",
        "GlobaleRmaNumber": "371104",
        "ReturnTrackingDetails": {
            "TrackingNumber": "1ZXXXXXXXXXXXXXXXX",
            "TrackingURL": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1ZX&requester=ST/",
            "IsQrLabel": "false",
            "IsTrackable": true
        },
        "ReturnDocuments": [
            {
                "DocumentTypeCode": "ShippingLabel",
                "DocumentTypeName": "Shipping Label",
                "DocumentData": "AQCkosNhECNeAACYzH/NIA5NgtHU2QAAAABJRU5ErkJggg==",
                "URL": "https://[MerchantDomain]/url"
            }
        ]
    },
}

Failure

{
        "Code": "error code",
        "Error": "error message",
        "Description: "error description"
        }

Example 1

    "IsSuccess": false,
    "Errors": [
        {
            "Code": "E500",
            "Error": "We encountered an unexpected error and are working to resolve the issue”,
            "Description": null,
            "Success": false
        }
    ]
}

Example 2

{
    "IsSuccess": false,
    "Errors": [
        {
            "Code": "PE27",
            "Error": "Return products collection has duplication",
            "Description": null,
            "Success": false
        },
        {
            "Code": "PE07",
            "Error": "Return product (DKB500680.M8) was not found for order",
            "Description": null,
            "Success": false
        },
        {
            "Code": "PE07",
            "Error": "Return product (B7ECS.C8) was not found for order",
            "Description": null,
            "Success": false
        }
    ]
}

SendRMAToMerchant (Global-e to Merchant)

Use the SendRMAToMerchant API to send the Global‑e RMA number to the merchant. Sends MerchantReturn object to the merchant.

This API streamlines the refund process for merchants. Merchants can initiate refunds directly from the Shopify Admin. Supports Shopify’s ability to get the return shipping fee when creating a return in their system.

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

Method/URL

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

Parameters

Request

Name	Type	Description	Mandatory
merchantOrder	Object merchantOrder	Provides order return details.
merchantReturn	Object merchantReturn	Provides merchant return information. Includes the following information: CreatedBy MerchantGUID MerchantOrderId OrderId ReturnedProducts ReturnShippingCost ReturnTrackingNumber RMANumber ShipperName TrackingURL

Return

Name	Type	Description	Mandatory
merchant.ResponseInfo	Object Merchant.ResponseInfo	Provides API call response info.

Objects for SendRMAToMerchant API

Merchant.Order

Parameter Name	Type	Description	Mandatory
`AdditionalRequiredDocuments`	List<orderDocoment>	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 emails FALSE - 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 cleared FALSE - 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`	Object Merchant.Customer	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`	Object DTBreakdown	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>	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 charged TRUE - 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`	Object Merchant.InternationalDetails	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 number FALSE - 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 place TRUE - The customer is a customer support agent and an “Offline order” took place FALSE - The customer is a regular customer
`IsReplacementOrder`	Boolean	Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - 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 split FALSE - Order is not to be split	No
`IsTaxExemption`	Boolean	Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - 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>	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`	Object DTBreakdown	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.
`OrderDocuments`	List<OrderDocument>	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>	List of payment methods the customer use (Credit card, Gift Cards)
`OrderStatusReason`	Object OrderStatusReason	Reason for the order status, why it was cancelled.
`OriginalOrder`	Object Merchant.OriginalOrder	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>	The list of parcels created for the order. Returned by `GetOrdersDetails` API only.	No
`PaymentDetails`	Object Merchant.PaymentDetails	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`	Object Merchant.CustomerDetails	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`	Object Merchant.CustomerDetails	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>	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`	Object Merchant.CustomerDetails	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`	Object Merchant.CustomerDetails	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>	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

Merchant.ResponseInfo

Parameter Name	Type	Description	Mandatory
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	No
`ErrorCode`	String	Error code to be returned when an error occurs.	No
`InternalOrderId`	String	Order unique identifier on the Merchant’s site	Optional if there was an error, a failure, or if the action is not related to a specific order
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	No
`OrderId`	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the `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`).	No
`PaymentAmount`	String	The total payment amount in `PaymentCurrency` charged for the order (if payment was processed in the respective API method call).	No
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	Optional if there was an error or failure
`Success`	Boolean	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

MerchantReturn

Parameter Name	Type	Description
`CreatedBy`	String	Who created the return
`MerchantGUID`	String	Merchant’s unique ID
`MerchantOrderId`	String	Merchant Order Id
`OrderId`	String	Order Id
`ReturnedProducts`	List<MerchantReturnProduct>	Products returned
`ReturnShippingCost`	Decimal	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

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

Response Example

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

UpdateRMA

Call the UpdateRMA API to set or update the MerchantRMANumber and send an email to the customer.

URL

https://{server_name}/Return/UpdateRMA

Parameters

Request

Name	Type	Description	Mandatory
updateRMANumber	Object UpdateRMANumber	Provides API call response info.

UpdateRMANumber

Parameter Name	Type	Description
`MerchantOrderId`	String	The Merchant order ID.
`MerchantRMANumber`	String	The Merchant return merchandise authorization number.
`OrderId`	String	The order ID.
`RMANumber`	String	The return merchandise authorization number.

Return

Name	Type	Description	Mandatory
merchant.ResponseInfo	Object Merchant.ResponseInfo	Provides API call response info.

Merchant.ResponseInfo

Parameter Name	Type	Description	Mandatory
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	No
`ErrorCode`	String	Error code to be returned when an error occurs.	No
`InternalOrderId`	String	Order unique identifier on the Merchant’s site	Optional if there was an error, a failure, or if the action is not related to a specific order
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	No
`OrderId`	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the `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`).	No
`PaymentAmount`	String	The total payment amount in `PaymentCurrency` charged for the order (if payment was processed in the respective API method call).	No
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	Optional if there was an error or failure
`Success`	Boolean	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Documentation Portal

Return Methods

GetReturnShippingOptions (Merchant to Global-e)

Important

Parameters

Products

Attributes

BillingDetails

UserIdNumberType

Brand

Category

DiscountsList

ShippingDetails

VATRateType

ReturnShippingDestinationDetails

ReturnShippingMethods

Errors

Examples

GetReturnDocuments (Merchant to Global-e)

Important

Parameters

ReturnAddress

ReturnedProduct

Data

ReturnDocuments

ReturnTrackingDetails

Errors

Examples

SendRMAToMerchant (Global-e to Merchant)

Parameters

Objects for SendRMAToMerchant API

Merchant.Order

Merchant.ResponseInfo

MerchantReturn

Examples

UpdateRMA

Parameters

UpdateRMANumber

Merchant.ResponseInfo

Examples

Search results