> ## Documentation Index
> Fetch the complete documentation index at: https://docs-stage.bglobale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update RMA

> Set or update the merchant's own RMA number (MerchantRMANumber) for a return and send the RMA email to the customer.

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.


## OpenAPI

````yaml api-reference/specs/updaterma.yaml POST /Return/UpdateRMA
openapi: 3.0.3
info:
  title: UpdateRMA
  version: 1.0.0
  description: >-
    Call the UpdateRMA API to set or update the MerchantRMANumber and send an
    email to the customer.
servers:
  - url: https://{globale_api_domain}
    variables:
      globale_api_domain:
        default: globale_api_domain
        description: Global-e API host, supplied to the merchant by Global-e.
security: []
tags:
  - name: UpdateRMA
    x-page-title: UpdateRMA
  - name: 'Direction: Merchant → Global-e'
  - name: 'Domain: Returns'
paths:
  /Return/UpdateRMA:
    post:
      tags:
        - UpdateRMA
      summary: UpdateRMA
      description: >-
        Call the UpdateRMA API to set or update the MerchantRMANumber and send
        an email to the customer.
      operationId: updateRMA
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRMANumber'
            example:
              OrderId: '12345'
              MerchantOrderId: '09876'
              RMANumber: '852147'
              MerchantRMANumber: '265646925'
      responses:
        '200':
          description: >-
            Merchant.ResponseInfo. Check the `Success` field; on failure,
            `Message` / `Description` / `ErrorCode` carry the error details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseInfo'
components:
  schemas:
    UpdateRMANumber:
      type: object
      title: UpdateRMANumber
      properties:
        OrderId:
          type: string
          description: The order ID.
        MerchantOrderId:
          type: string
          description: The Merchant order ID.
        RMANumber:
          type: string
          description: The return merchandise authorization number.
        MerchantRMANumber:
          type: string
          description: The Merchant return merchandise authorization number.
    ResponseInfo:
      type: object
      title: Merchant.ResponseInfo
      description: Provides API call response info.
      properties:
        Description:
          type: string
          description: >-
            Optional response description. In case of an error, this property
            indicates the error message description.
        ErrorCode:
          type: string
          description: Error code to be returned when an error occurs.
        InternalOrderId:
          type: string
          description: Order unique identifier on the Merchant's site.
        Message:
          type: string
          description: >-
            Optional response message. In case of an error, this property
            indicates the error message text.
        OrderId:
          type: string
          description: >-
            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:
          type: string
          description: >-
            The total payment amount in PaymentCurrency charged for the order
            (if payment was processed in the respective API method call).
        PaymentCurrencyCode:
          type: string
          description: >-
            3-char ISO currency code for the order (if payment was processed in
            the respective API method call).
        StatusCode:
          type: string
          description: >-
            Code denoting the order status on the Merchant's site (to be mapped
            on the Global-e side).
        Success:
          type: boolean
          description: >-
            Indicates if the call has succeeded. TRUE - Call succeeded. FALSE -
            Denotes an error or failure.

````