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

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>	Each product object has the following fields: `ProductCode` `CartItemID` `ReturnQuantity`	Yes
`ReturnShippingMethodId`	Long	Provides the ID of the return shipping method.	No

Response

Name	Type	Description	Mandatory
`Cost`	Double	The cost of the shipment	Yes
`Currency`	String	3-letter currency ISO code	Yes
`IsQrLabel`	Boolean	Whether this is a label-free return (QR code only). Only applicable to the `ShippingLabel` object. True for a label-free return Falsefor a return with label	No
`isTrackable`	Boolean	True for carriers that Global-e has Tracking events integrations with. False for carriers for which Global-e does not support Tracking capabilities.	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`	ObjectReturnShippingDestinationDetails	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`	Int	The shipping method identifier. Can be used when calling GetReturnDocuments to receive the return document for the selected shipping method.	Yes
`ShippingMethodType`	String	Identifies the shipping method type.	Yes
[ShippingMethodTypeId]	Int	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

Objects for GetReturnShippingOptions API

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 Shipping Details	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

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
State or Province	String	State / province / county for return shipping	No
Zip	String	Zip for return shipping	Yes

ReturnShippingMethods

Parameter Name	Type	Description	Mandatory
`Cost`	Decimal	Shipment cost.
`Currency`	Boolean	Currency used for shipment cost.
`IsQrLabel`	Boolean	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`	Boolean	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.

Error Responses

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

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

GetReturnDocuments (Merchant to Global-e)

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

The API return documents and related information, including the label, the tracking number, the tracking URL, the shipper name, the commercial invoice (if relevant), the RMA number, and the return note. In addition, Global-e creates a Global-e RMA.

Note: Electronic invoices are not returned.

Important

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

Method/URL

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

Parameters

Request

Field	Type	Description	Mandatory
`CultureCode`	String	The language for the Return Note document. Currently, English is the only supported language. Maximum 10 characters	No
`CurrencyCode`	String	The currency of the returned prepaid shipping cost (*) Mandatory: Yes, if the `ShippingCost` parameter is greater than 0. Maximum 3 characters	Yes
`Email`	String	The customer's email address Maximum 100 characters	Yes
`MerchantRMANumber`	String	The Merchant's internal RMA Number Maximum 200 characters	No
`OrderId`	String	The order unique ID Maximum 100 characters	Yes
`ProviderCode`	String	The Provider's name identifies the source of the request.	Yes
`ReturnedProducts`	Array	An array of returned products' details.	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.	No
`ReturnShippingTypeId`	Integer	Possible values: `1 -` Returns an appropriate validation error. See Error Codes. `2 - Prepaid` `3 - Local Prepaid Courier` `4 - Local Prepaid`	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

Response

If the API call is successful, the Data object returns the documents required for the return. If the call fails, it returns FailedTrackingNumbers.

Field	Type	Description
`Data`	Object Data	Provides information about the order. If the API call is successful, returns the documents required for the return.
`Error`	String	If the API call fails, provides information about the failure.
`IsSuccess`	Boolean	True: If the API call is successful. False: If the API call fails.

Field

Type

Description

Data

Object Data

Provides information about the order. If the API call is successful, returns the documents required for the return.

Error

String

If the API call fails, provides information about the failure.

IsSuccess

Boolean

True: If the API call is successful.

False: If the API call fails.

Objects for GetReturnsDocuments API

Field	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.

Parameter Name	Type	Description
`Code`	String	The error code
`error`	String	The error message
`Description`	String	The error description

FailedTrackingNumbers

Parameter Name	Type	Description
`ErrorInfo`	Object	ErrorInfo object with the error code and error details
`OrderID`	String	Unique order identifier
`Success`	Bool	Indicates success or failure
`TrackingNumber`	String	The Global-e tracking number.

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

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

Field	Type	Description	Mandatory
`IsQrLabel`	Boolean	Identifies whether this is a label-free return (QR code only). This is only applicable to the `ShippingLabel` object.	No
`IsTrackable`	Boolean	True for supported by Global-e for tracking capabilities and tracking events. False for carriers that Global‑e does not support Tracking capabilities	No
`ShipperName`	String	Identifies the name of the shipping service for the return provider.	Yes
`TrackingNumber`	String	Reference number for the tracking service used by the shipper for this return.	Yes
`TrackingURL`	String	The tracking URL of the tracking service site used by the shipper.	Yes

Error Codes

Error Code	Error 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}) <See also Allowed Return Statuses>
E03	The Order ID was not found
E04	There is already an RMA request for this order ({0})
E05	There are multiple orders with these details ({0})
E06	The return is not allowed due to the parcel status ({0}) <See also Allowed Return Statuses>
E07	Unable to find the shipping method for the provided return shipping method Id ({0}) <See also Return Shipping Service Types >
E08	The provided ReturnShippingTypeId is not valid ({0}) <See also Return Shipping Service Types>
E09	There are multiple orders with this Order ID ({0})
E10	No shipping options were found for the order return ({0})
E11	The return shipping address was not found for order ({0})
E12	Invalid currency code for the provided shipping cost for order ({0})
E13	The return shipping request failed 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

Product Errors

Error Code	Error Message
PE01	Unable to process this request as the returns period has expired for the product ({0})
PE02	The return product ({0}) was not found for the order
PE03	Product ({0}) is not returnable
PE04	Unable to find the shipping method for the return shipping method id ({0})
PE05	The requested return product quantity was not delivered to the customer ({0})
PE06	The requested return product is virtual ({0})
PE07	The requested return product contains dangerous goods ({0})
PE08	The requested return product quantity is zero ({0})
PE09	The OrderProduct was not found for the requested return product ({0})
PE10	The child return product was requested without the parent product ({0})
PE11	The order product delivery quantity is zero ({0})
PE12	The order product unit sale price is zero ({0})
PE13	The return reason code was not found for the requested product ({0})
PE14	The return product collection has duplications

Model Validation Errors

Error Code	Error Message
ME01	The input value for `ProductCode` is Invalid
ME02	The input value for `CartItemIdInvalid` 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

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",
			"ProductSecondaryCode": "",
			"CartItemId": null,
			"ReturnQuantity": 1,
			"MerchantReturnReasonCode": "",
			"MerchantReturnReasonDescription": "Return Reason from GRD request for product 1"
		},
		{
			"ProductCode": "B7ECS.C8",
			"ProductSecondaryCode": "",
			"CartItemId": 1,
			"ReturnQuantity": 1,
			"MerchantReturnReasonCode": "TTT",
			"MerchantReturnReasonDescription": "Return Reason from GRD request for product 2"
		}
	]
}'

Response

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"
            }
        ]
    },
    "Errors": null
}

Failure

Example 1

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

Example 2

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

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.

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

Tracking Events API

Prerequisites

The request can include a list of global-e order IDs, a list of tracking events, or both, but all the same type: Inbound or Outbound. Each request can report on either inbound orders or outbound, but not both. For requesting inbound and outbound tracking events, two different requests should be issued.

GetTrackingEvents (Merchant to Global-e)

The Get Tracking Events API lets you receive status events on the delivery status of an order. Reporting of tracking events allows both our customers and 3^rd parties to stay informed about the exact location and status of returned items throughout the entire external return journey.

With that, having tracking events for return shipments allows to trigger refunds automatically upon confirmation of returned item receipt (or any other tracking event).

The API accepts one or more order ID numbers, up to 100, on a single call, a list of either orders moved to forward shipments, after checkout completion (outbound), or returns (inbound) and returns their status.

Method/URL:

POST https://{globale_api_domain}/Shipment/GetTrackingEvents

Regarding the API domain, for more details about relevant environments, see Global-e Environments.

Parameters

Request

Parameter	Type	Description	Mandatory
`EventSinceInUTC`	DateTime	Date and time for the earliest time of the order shipment status, UTC, in RFC 2822 format (for example, Fri, 8 Aug 2014 17:13:07 +0000).	No
`OrderIds`	List of strings	List of Global‑e Order IDs. Up to 100 in each request. Note: each `OrderId`, string, has prefix `GE` followed by numbers, in the format `GE1234`. Max length:100 chars.	One of either `OrderIds` or `TrackingNumbers` are mandatory.
`TrackingNumbers`	List of strings	List of Global‑e tracking numbers. Up to 100 in each request, with prefix `GE` followed by numbers in the format `GE1234`.	Conditional
`Type`	String	The shipment direction. One of the following: inbound outbound	Yes

Response

Parameter	Type	Description	Mandatory
`FailedTrackingNumbers`	List<FailedTrackingNumbers>	List of objects containing detailed error information. The object includes: `Code` `Description` `Error` `OrderID` `Success`
`SuccessfulTrackingNumbers`	Object SuccessfulTrackingNumbers	The events for each `OrderId` are listed in the request. The SuccessfulTrackingNumbers object includes: `GlobaleOrderID` `GlobaleParcelCode` `GlobaleRMANumber (for returns)` `IsTrackingNumberActive` `MerchantOrderID` `MerchantRMANumber (for returns)` `ShipperName` `TrackingEvents` Object. Tracking details for each Global-e order ID in the request, in ascending tracing event time: `GlobaleEventCode` `GlobaleEventDescription` `Location` – Object of `FullAddress` `ShipperEventCode` `ShipperEventDescription` `TrackingEventDateTimeInUTC` `TrackingEventStatus`: One of the following values: DispatchedToCustomer DeliveryAttempt Delivered ReturnedByShipper `TrackingNumber` `TrackingURL` One of the following values: inbound or outbound

Objects for GetTrackingEvents API

FailedTrackingNumbers

Parameter Name	Type	Description
`ErrorInfo`	Object	ErrorInfo object with the error code and error details
`OrderID`	String	Unique order identifier
`Success`	Bool	Indicates success or failure
`TrackingNumber`	String	The Global-e tracking number.

SuccessfulTrackingNumbers

Parameter Name	Type	Description
`GlobaleOrderID`	String	The Global-e order ID for the parcel.
`GlobaleParcelCode`	String	The parcel code used by Global-e.
`GlobaleRMANumber`	String	The Global‑e RMA nnumber.
`IsTrackingNumberActive`	Boolean	Identifies if the tracking number is in use.
`MerchantOrderID`	String	The order ID used by the merchant for the order.
`MerchantRMANumber`	String	The return merchandise authorization number used by the merchant for the parcel.
`ShipperName`	String	The shipping method name.
`TrackingEvents`	Class TrackingEvents	Information about order and tracking events.
`TrackingNumber`	String	Global‑e tracking number, with prefix `GE` followed by numbers in the format `GE1234`.
`TrackingURL`	String	Full tracking URL used for this parcel.
`Type`	String	Type of shipment. One of the following values: inbound or outbound

Global-e Tracking Events

The following table lists all the tracking events reported by Global-e:

GlobaleEventCode	GlobaleEventDescription
1	The parcel has been created but is waiting to be manifested (i.e. despatched)
2	The parcel has been manifested (i.e.. despatched)
3	The carrier has yet to receive the parcel into their network
4	The carrier has acknowledged receipt of the parcel into their network
5	The carrier has acknowledged receipt of the parcel into their network but did not receive the required electronic manifest (pre advice file)
6	A collection request has been acknowledged by the carrier
7	The carrier has successfully collected a parcel from a customer
8	The carrier has failed to collect a parcel from a customer
9	The parcel has been misrouted by the carrier due to incorrect routing on the label
10	The parcel has been misrouted by the carrier due to incorrect routing on the label
11	The parcel has been advised as lost within the carriers network
12	The parcel has been delayed due to factors beyond the carriers control (i.e. inclement weather)
13	The parcel is with Customs (NR: This does not necessarily mean that the parcel has been refused entry into the destination country)
14	The parcel has been damaged
15	The parcel is in transit (NB: This could either be en route to a country hubs delivery depot)
16	The parcel has been Left at the local post office for collection
17	The parcel is with a 3rd party sub-contractor and a tracking event has occurred (refer to "Confirmation' field for further information if provided
18	The parcel has left the delivery depot for the recipients address
19	The parcel has been received by a sub-contractor 3rd party
20	The carrier has a query concerning the recipients address (i.e. Unable to locate,. incorrect post code etc.)
21	The carrier has left a calling card for the customer as they were unable to deliver the parcel
22	The carrier has delivered part of the consignment advised (e.g. Parcel 1 parcel of a 2 parcel consignment has been delivered)
23	The parcel is available to collect from the carriers premises
24	The parcel is being held at the delivery depot
25	The recipient no longer resides at the delivery address
26	The recipient refused to take delivery of the parcel
27	The parcel is to be returned to the sender
28	The carrier was unable to deliver the parcel (No reason specified)
29	The parcel has been successfully delivered
30	The carrier has provided some information concerning the parcel
31	An event has occurred after the parcel has been delivered / lost or RTS (i.e._ acknowledgement of a claim)
32	Special delivery instructions to app.?
33	The delivery / collection has requested to be cancelled
34	The carrier has received an electronic pre advice (manifest) for this parcel
35	The parcel has been at a bstatus that does not set an actual or default end date and as such has been 'closed" after a certain period of time dependent on the environment it belongs to
36	The parcel was miss sorted by the carrier and sent to the incorrect -deliver? dept.
37	The recipient has arranged a delivery with the carrier
38	The carrier attempted to deliver the parcel but was unable to access the recipients address to deliver or leave a inning card (i.e. Closed office building, gate-d development etc)
39	The payment for cash on delivery could not be collected
40	The recipient's identification failed
41	The payment could not be processed due to an invalid method of payment by recipient.
42	The payment for cash on delivery of parcel has been collected by the carrier
43	The parcel has been cleared for delivery
44	The parcel has been re boxed / re packed
45	The parcel has been requested to be disposed
46	The declared weight of the parcel does not match the actual weight of the parcel.
47	The parcel has been held by destination Customs
48	The parcel has been held by origin Customs
49	The parcel has been delivered to a neighbour's address
50	The parcel has been delivered to a safe place suggested by the recipient
51	The customer has collected the parcel from the store
52	The parcel is received at store and is ready for collection by recipient_
53	The parcel is ready for collection at the store and it has not been collected after a period of time
54	The parcel has been delivered to a locker or collection point and is ready to be collected by the recipient.
55	The parcel has been delivered to the recipient's preferred point instead of collecting from depot or re-delivery or return
56	The package has been held by the carrier whilst collecting recipient details for clearance
57	The parcel has been re-labelled
58	The parcel attributes lie outside of service capability i.e. weight/size/remote area issues
59	An SMS has been transmitted to the recipient to inform that the parcel is out for deliver). today
60	An email has been transmitted to the recipient to inform that the parcel is out for delivery today
61	The carrier attempted delivering the parcel but could not deliver
62	The package/s arrived to the destination country
63	A choice that the customer has made for delivery to a safe place (the delivery not happened yet)

Examples

Request

Request for only Global-e orders:

curl --location 'https://[globale domain]/Shipment/GetTrackingEvents' \
 --header 'MerchantGUID: D2ED2A7F-F6ED-4CCB-B611-B44AC8D02250' \ 
{
  "EventSinceInUTC": "2025-04-01T20:08:05Z",
  "Type": "outbound",
  "OrderIds": [
    "GE381652418TS"
],
    "TrackingNumbers":[
]}

Response

{
    "Data": {
        "SuccessfulTrackingNumbers": [
            {
                "GlobaleOrderID": "GE381652418US",
                "MerchantOrderID": "#22165241",
                "GlobaleParcelCode": "null",
                "GlobaleRMANumber": "2832849023948",
                "MerchantRMANumber": "832849932893",
                "IsTrackingNumberActive": true,
                "TrackingNumber": "GE381652418TS2864637A0",
                "Type": "outbound",
                "TrackingUrl": "https://mailingtechnology.com/tracking/?tn=GE381652418TS2864637A0",
                "ShipperName": "Spring XBS Packet Registered-GlobalE",
                "TrackingEvents": [
                    {
                        "ShipperEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "TrackingEventDateTimeInUTC": "2024-03-24T09:19:08",
                        "GlobaleEventCode": "1",
                        "GlobaleEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "ShipperEventCode": "0",
                        "TrackingEventStatus": [],
                        "Location": {
                            "FullAddress": "BALTIMORE AIRPORT,MD-USA"
                        }
                    }
                ]
            },
            {
                "GlobaleOrderID": "GE8770052418US",
                "MerchantOrderID": "#23816524",
                "GlobaleParcelCode": "null",
                "GlobaleRMANumber": "0239283284948",
                "MerchantRMANumber": "8884994993293",
                "IsTrackingNumberActive": true,
                "TrackingNumber": "GE381652418TS2864637A0",
                "Type": "outbound",
                "TrackingUrl": "https://mailingtechnology.com/tracking/?tn=GE381652418TS2864637A0",
                "ShipperName": "Spring XBS Packet Registered-GlobalE",
                "TrackingEvents": [
                    {
                        "ShipperEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "TrackingEventDateTimeInUTC": "2024-03-24T09:19:16",
                        "GlobaleEventCode": "1",
                        "GlobaleEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "ShipperEventCode": "0",
                        "TrackingEventStatus": [],
                        "Location": {
                            "FullAddress": "BALTIMORE AIRPORT,MD-USA"
                        }
                    }
                ]
            }
        ],
        "FailedTrackingNumbers": [
           {
            "OrderId": "ABC123",
            "TrackingNumber": "123",
            "ErrorInfo": {
               "Code": "E06",
               "Error": "The tracking number (123) is not associated with the merchant",
               "Description": null
            },
         "Success": false
         }
      ]
    },
    "Errors": null
}

UpdateRMA

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

Method/URL

https://{server_name}/Return/UpdateRMA?merchantGUID= F3BE2R-8546-FC38-90SJ-1C780SG8F90SBS

Parameters

Request

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

Return

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

Objects for SendRMAToMerchant API

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`	Bool	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

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.

Examples

Request

{
    “OrderId”: ”12345”, (optional)
    “MerchantOrderId”: ”09876”, (optional)
    ”RMANumber”: ”852147”, 
    ”MerchantRMANumber”: ”265646925”
}

Documentation Portal

Return Methods

GetReturnShippingOptions (Merchant to Global-e)

Important

Parameters

Objects for GetReturnShippingOptions API

Products

ReturnShippingDestinationDetails

ReturnShippingMethods

Error Responses

Examples

GetReturnDocuments

GetReturnDocuments (Merchant to Global-e)

Important

Parameters

Objects for GetReturnsDocuments API

ErrorInfo

FailedTrackingNumbers

ReturnDocuments

Error Codes

Examples

SendRMAToMerchant (Global-e to Merchant)

Parameters

Objects for SendRMAToMerchant API

Merchant.Order

Merchant.ResponseInfo

MerchantReturn

Examples

Tracking Events API

Prerequisites

GetTrackingEvents (Merchant to Global-e)

Parameters

Objects for GetTrackingEvents API

FailedTrackingNumbers

SuccessfulTrackingNumbers

Global-e Tracking Events

Examples

UpdateRMA

Parameters

Objects for SendRMAToMerchant API

Merchant.ResponseInfo

UpdateRMANumber

Examples

Search results