Skip to main content
POST
Get available return shipping options for an order
Part of the Returns via API integration guide — see it for when and how to use this endpoint.

Body

application/json
OrderId
string
required

Unique Global-e Order ID or Merchant Order ID. Maximum: 100 characters.

Maximum string length: 100
ProviderCode
string
required

Provider name that identifies the source of the request.

ReturnedProducts
ReturnedProduct · object[]
required

The products being returned. Each item carries CartItemId, MerchantReturnReasonCode, MerchantReturnReasonDescription, ProductCode and ReturnQuantity.

CultureCode
string

10-character code. Default is EN. Maximum: 10 characters.

Maximum string length: 10
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.

Email
string

Email that identifies the source of the request.

ReturnShippingMethodId
integer<int64>

Provides the ID of the return shipping method.

Response

The available return shipping methods for the order, with costs and the return destination details, wrapped in the standard IsSuccess / Data envelope.

IsSuccess
boolean

Indicates whether the API call succeeded.

Data
ReturnShippingOptionsData · object