curl --request POST \
--url https://{globale_api_domain}/Return/GetReturnShippingOptions \
--header 'Content-Type: application/json' \
--data '
{
"ProviderCode": "ExampleProvider",
"OrderId": "EUQA6215359",
"Email": "shopper@example.com",
"ReturnedProducts": [
{
"ProductCode": "433117270672",
"ReturnQuantity": 1
}
]
}
'import requests
url = "https://{globale_api_domain}/Return/GetReturnShippingOptions"
payload = {
"ProviderCode": "ExampleProvider",
"OrderId": "EUQA6215359",
"Email": "shopper@example.com",
"ReturnedProducts": [
{
"ProductCode": "433117270672",
"ReturnQuantity": 1
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ProviderCode: 'ExampleProvider',
OrderId: 'EUQA6215359',
Email: 'shopper@example.com',
ReturnedProducts: [{ProductCode: '433117270672', ReturnQuantity: 1}]
})
};
fetch('https://{globale_api_domain}/Return/GetReturnShippingOptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{globale_api_domain}/Return/GetReturnShippingOptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ProviderCode' => 'ExampleProvider',
'OrderId' => 'EUQA6215359',
'Email' => 'shopper@example.com',
'ReturnedProducts' => [
[
'ProductCode' => '433117270672',
'ReturnQuantity' => 1
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{globale_api_domain}/Return/GetReturnShippingOptions"
payload := strings.NewReader("{\n \"ProviderCode\": \"ExampleProvider\",\n \"OrderId\": \"EUQA6215359\",\n \"Email\": \"shopper@example.com\",\n \"ReturnedProducts\": [\n {\n \"ProductCode\": \"433117270672\",\n \"ReturnQuantity\": 1\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{globale_api_domain}/Return/GetReturnShippingOptions")
.header("Content-Type", "application/json")
.body("{\n \"ProviderCode\": \"ExampleProvider\",\n \"OrderId\": \"EUQA6215359\",\n \"Email\": \"shopper@example.com\",\n \"ReturnedProducts\": [\n {\n \"ProductCode\": \"433117270672\",\n \"ReturnQuantity\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{globale_api_domain}/Return/GetReturnShippingOptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"ProviderCode\": \"ExampleProvider\",\n \"OrderId\": \"EUQA6215359\",\n \"Email\": \"shopper@example.com\",\n \"ReturnedProducts\": [\n {\n \"ProductCode\": \"433117270672\",\n \"ReturnQuantity\": 1\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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,
"Currency": "EUR"
}
],
"ReturnShippingDestinationDetails": {
"Country": "Netherlands",
"City": "Amsterdam",
"Address": "Ood 5",
"Zip": "4751XK",
"StateOrProvince": "",
"Email": "shopper@example.com",
"Phone": "310610887191"
}
}
}{
"Code": "error code",
"Error": "error message",
"Description": "error description"
}Get return shipping options
Returns the available return shipping methods and costs for an order, plus the return destination address.
curl --request POST \
--url https://{globale_api_domain}/Return/GetReturnShippingOptions \
--header 'Content-Type: application/json' \
--data '
{
"ProviderCode": "ExampleProvider",
"OrderId": "EUQA6215359",
"Email": "shopper@example.com",
"ReturnedProducts": [
{
"ProductCode": "433117270672",
"ReturnQuantity": 1
}
]
}
'import requests
url = "https://{globale_api_domain}/Return/GetReturnShippingOptions"
payload = {
"ProviderCode": "ExampleProvider",
"OrderId": "EUQA6215359",
"Email": "shopper@example.com",
"ReturnedProducts": [
{
"ProductCode": "433117270672",
"ReturnQuantity": 1
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ProviderCode: 'ExampleProvider',
OrderId: 'EUQA6215359',
Email: 'shopper@example.com',
ReturnedProducts: [{ProductCode: '433117270672', ReturnQuantity: 1}]
})
};
fetch('https://{globale_api_domain}/Return/GetReturnShippingOptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{globale_api_domain}/Return/GetReturnShippingOptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ProviderCode' => 'ExampleProvider',
'OrderId' => 'EUQA6215359',
'Email' => 'shopper@example.com',
'ReturnedProducts' => [
[
'ProductCode' => '433117270672',
'ReturnQuantity' => 1
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{globale_api_domain}/Return/GetReturnShippingOptions"
payload := strings.NewReader("{\n \"ProviderCode\": \"ExampleProvider\",\n \"OrderId\": \"EUQA6215359\",\n \"Email\": \"shopper@example.com\",\n \"ReturnedProducts\": [\n {\n \"ProductCode\": \"433117270672\",\n \"ReturnQuantity\": 1\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{globale_api_domain}/Return/GetReturnShippingOptions")
.header("Content-Type", "application/json")
.body("{\n \"ProviderCode\": \"ExampleProvider\",\n \"OrderId\": \"EUQA6215359\",\n \"Email\": \"shopper@example.com\",\n \"ReturnedProducts\": [\n {\n \"ProductCode\": \"433117270672\",\n \"ReturnQuantity\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{globale_api_domain}/Return/GetReturnShippingOptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"ProviderCode\": \"ExampleProvider\",\n \"OrderId\": \"EUQA6215359\",\n \"Email\": \"shopper@example.com\",\n \"ReturnedProducts\": [\n {\n \"ProductCode\": \"433117270672\",\n \"ReturnQuantity\": 1\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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,
"Currency": "EUR"
}
],
"ReturnShippingDestinationDetails": {
"Country": "Netherlands",
"City": "Amsterdam",
"Address": "Ood 5",
"Zip": "4751XK",
"StateOrProvince": "",
"Email": "shopper@example.com",
"Phone": "310610887191"
}
}
}{
"Code": "error code",
"Error": "error message",
"Description": "error description"
}Body
Unique Global-e Order ID or Merchant Order ID. Maximum: 100 characters.
100Provider name that identifies the source of the request.
The products being returned. Each item carries CartItemId, MerchantReturnReasonCode, MerchantReturnReasonDescription, ProductCode and ReturnQuantity.
Show child attributes
Show child attributes
10-character code. Default is EN. Maximum: 10 characters.
10The 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 that identifies the source of the request.
Provides the ID of the return shipping method.

