Update RMA

UpdateRMA

curl --request POST \
  --url https://{globale_api_domain}/Return/UpdateRMA \
  --header 'Content-Type: application/json' \
  --data '
{
  "OrderId": "12345",
  "MerchantOrderId": "09876",
  "RMANumber": "852147",
  "MerchantRMANumber": "265646925"
}
'

import requests

url = "https://{globale_api_domain}/Return/UpdateRMA"

payload = {
    "OrderId": "12345",
    "MerchantOrderId": "09876",
    "RMANumber": "852147",
    "MerchantRMANumber": "265646925"
}
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({
    OrderId: '12345',
    MerchantOrderId: '09876',
    RMANumber: '852147',
    MerchantRMANumber: '265646925'
  })
};

fetch('https://{globale_api_domain}/Return/UpdateRMA', 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/UpdateRMA",
  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([
    'OrderId' => '12345',
    'MerchantOrderId' => '09876',
    'RMANumber' => '852147',
    'MerchantRMANumber' => '265646925'
  ]),
  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/UpdateRMA"

	payload := strings.NewReader("{\n  \"OrderId\": \"12345\",\n  \"MerchantOrderId\": \"09876\",\n  \"RMANumber\": \"852147\",\n  \"MerchantRMANumber\": \"265646925\"\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/UpdateRMA")
  .header("Content-Type", "application/json")
  .body("{\n  \"OrderId\": \"12345\",\n  \"MerchantOrderId\": \"09876\",\n  \"RMANumber\": \"852147\",\n  \"MerchantRMANumber\": \"265646925\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{globale_api_domain}/Return/UpdateRMA")

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  \"OrderId\": \"12345\",\n  \"MerchantOrderId\": \"09876\",\n  \"RMANumber\": \"852147\",\n  \"MerchantRMANumber\": \"265646925\"\n}"

response = http.request(request)
puts response.read_body

{
  "Description": "<string>",
  "ErrorCode": "<string>",
  "InternalOrderId": "<string>",
  "Message": "<string>",
  "OrderId": "<string>",
  "PaymentAmount": "<string>",
  "PaymentCurrencyCode": "<string>",
  "StatusCode": "<string>",
  "Success": true
}

POST

Return

UpdateRMA

curl --request POST \
  --url https://{globale_api_domain}/Return/UpdateRMA \
  --header 'Content-Type: application/json' \
  --data '
{
  "OrderId": "12345",
  "MerchantOrderId": "09876",
  "RMANumber": "852147",
  "MerchantRMANumber": "265646925"
}
'

import requests

url = "https://{globale_api_domain}/Return/UpdateRMA"

payload = {
    "OrderId": "12345",
    "MerchantOrderId": "09876",
    "RMANumber": "852147",
    "MerchantRMANumber": "265646925"
}
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({
    OrderId: '12345',
    MerchantOrderId: '09876',
    RMANumber: '852147',
    MerchantRMANumber: '265646925'
  })
};

fetch('https://{globale_api_domain}/Return/UpdateRMA', 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/UpdateRMA",
  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([
    'OrderId' => '12345',
    'MerchantOrderId' => '09876',
    'RMANumber' => '852147',
    'MerchantRMANumber' => '265646925'
  ]),
  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/UpdateRMA"

	payload := strings.NewReader("{\n  \"OrderId\": \"12345\",\n  \"MerchantOrderId\": \"09876\",\n  \"RMANumber\": \"852147\",\n  \"MerchantRMANumber\": \"265646925\"\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/UpdateRMA")
  .header("Content-Type", "application/json")
  .body("{\n  \"OrderId\": \"12345\",\n  \"MerchantOrderId\": \"09876\",\n  \"RMANumber\": \"852147\",\n  \"MerchantRMANumber\": \"265646925\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{globale_api_domain}/Return/UpdateRMA")

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  \"OrderId\": \"12345\",\n  \"MerchantOrderId\": \"09876\",\n  \"RMANumber\": \"852147\",\n  \"MerchantRMANumber\": \"265646925\"\n}"

response = http.request(request)
puts response.read_body

{
  "Description": "<string>",
  "ErrorCode": "<string>",
  "InternalOrderId": "<string>",
  "Message": "<string>",
  "OrderId": "<string>",
  "PaymentAmount": "<string>",
  "PaymentCurrencyCode": "<string>",
  "StatusCode": "<string>",
  "Success": true
}

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

Overview

Use the UpdateRMA endpoint to set or update the Return Merchandise Authorization (RMA) number on an existing return, then trigger the RMA confirmation email to the shopper. Send the merchant’s own return authorization number in the MerchantRMANumber field and Global-e stores it against the order. Identify the return by OrderId or MerchantOrderId, and optionally include Global-e’s own RMANumber. This is the API behind the UpdateRMA step of the SFCC GlobaleOrderNotifications job, letting merchants push a return authorization number from their returns or OMS platform back to Global-e for customer-facing return communications.

Body

application/json

OrderId

string

The order ID.

MerchantOrderId

string

The Merchant order ID.

RMANumber

string

The return merchandise authorization number.

MerchantRMANumber

string

The Merchant return merchandise authorization number.

Response

200 - application/json

Merchant.ResponseInfo. Check the Success field; on failure, Message / Description / ErrorCode carry the error details.

Provides API call response info.

Description

string

Optional response description. In case of an error, this property indicates the error message description.

ErrorCode

string

Error code to be returned when an error occurs.

InternalOrderId

string

Order unique identifier on the Merchant's site.

Message

string

Optional response message. In case of an error, this property indicates the error message text.

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

PaymentAmount

string

The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call).

PaymentCurrencyCode

string

3-char ISO currency code for the order (if payment was processed in the respective API method call).

StatusCode

string

Code denoting the order status on the Merchant's site (to be mapped on the Global-e side).

Success

boolean

Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

⌘I

Overview

Shipping

Orders

Returns

Gift Cards

Checkout

Pricing

Browsing & Catalog

Webhooks

Shared Objects

Overview

Body

Response

​Overview

Body

Response

Overview