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

# Get return shipping options

> Returns the available return shipping methods and costs for an order, plus the return destination address.

<Note>
  Part of the [Returns via API](/returns-via-api) integration guide — see it for when and how to use this endpoint.
</Note>


## OpenAPI

````yaml api-reference/specs/getreturnshippingoptions.yaml POST /Return/GetReturnShippingOptions
openapi: 3.0.3
info:
  title: GetReturnShippingOptions
  version: 1.0.0
  description: >-
    The Return Shipping Options API provides essential return information,
    including a list of return shipping methods available for a specific order
    and their associated costs.
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: GetReturnShippingOptions
    x-page-title: GetReturnShippingOptions
  - name: 'Direction: Merchant → Global-e'
  - name: 'Domain: Returns'
paths:
  /Return/GetReturnShippingOptions:
    post:
      tags:
        - GetReturnShippingOptions
      summary: Get available return shipping options for an order
      description: >-
        Returns the return shipping methods available for the requested order
        and products, together with their costs and the return destination
        address.
      operationId: getReturnShippingOptions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnShippingOptionsRequest'
            example:
              ProviderCode: ExampleProvider
              OrderId: EUQA6215359
              Email: shopper@example.com
              ReturnedProducts:
                - ProductCode: '433117270672'
                  ReturnQuantity: 1
      responses:
        '200':
          description: >-
            The available return shipping methods for the order, with costs and
            the return destination details, wrapped in the standard `IsSuccess`
            / `Data` envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReturnShippingOptionsResponse'
              example:
                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'
        '400':
          description: >-
            Error response. The documented "General Error Response" is an
            `ErrorInfo` object (`Code` / `Error` / `Description`). See the
            integration guide for the full list of documented error codes (E-,
            ME-, PE-).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
              example:
                Code: error code
                Error: error message
                Description: error description
components:
  schemas:
    ReturnShippingOptionsRequest:
      type: object
      title: ReturnShippingOptionsRequest
      required:
        - OrderId
        - ProviderCode
        - ReturnedProducts
      properties:
        CultureCode:
          type: string
          maxLength: 10
          description: '10-character code. Default is EN. Maximum: 10 characters.'
        CurrencyCode:
          type: string
          description: >-
            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:
          type: string
          description: Email that identifies the source of the request.
        OrderId:
          type: string
          maxLength: 100
          description: >-
            Unique Global-e Order ID or Merchant Order ID. Maximum: 100
            characters.
        ProviderCode:
          type: string
          description: Provider name that identifies the source of the request.
        ReturnedProducts:
          type: array
          description: >-
            The products being returned. Each item carries CartItemId,
            MerchantReturnReasonCode, MerchantReturnReasonDescription,
            ProductCode and ReturnQuantity.
          items:
            $ref: '#/components/schemas/ReturnedProduct'
        ReturnShippingMethodId:
          type: integer
          format: int64
          description: Provides the ID of the return shipping method.
    GetReturnShippingOptionsResponse:
      type: object
      title: GetReturnShippingOptionsResponse
      properties:
        IsSuccess:
          type: boolean
          description: Indicates whether the API call succeeded.
        Data:
          $ref: '#/components/schemas/ReturnShippingOptionsData'
    ErrorInfo:
      type: object
      title: ErrorInfo
      description: Error response (Code / Error / Description form).
      properties:
        Code:
          type: string
          description: The error code.
        Error:
          type: string
          description: The error message.
        Description:
          type: string
          description: The error description.
    ReturnedProduct:
      type: object
      title: ReturnedProduct
      required:
        - ProductCode
        - ReturnQuantity
      properties:
        CartItemId:
          type: string
          maxLength: 50
          description: Identifier of the cart item. Maximum 50 characters.
        MerchantReturnReasonCode:
          type: string
          maxLength: 100
          description: >-
            The code of the reason for the product return on the merchant.
            Maximum 100 characters.
        MerchantReturnReasonDescription:
          type: string
          maxLength: 100
          description: >-
            The description of the reason for the return on the merchant site.
            Maximum 100 characters. Mandatory if no reason code provided.
        ProductCode:
          type: string
          maxLength: 600
          description: The ProductCode identifying the product. Maximum 600 characters.
        ReturnQuantity:
          type: integer
          description: Quantity of the returned product. Maximum 100 characters.
    ReturnShippingOptionsData:
      type: object
      title: ReturnShippingOptionsData
      properties:
        OrderId:
          type: string
          maxLength: 100
          description: 'The unique Global-e Order ID. Maximum: 100 characters'
        MerchantOrderId:
          type: string
          maxLength: 100
          description: 'The unique merchant Order ID. Maximum: 100 characters'
        ReturnShippingMethods:
          type: array
          description: The available return shipping options for the requested items.
          items:
            $ref: '#/components/schemas/ReturnShippingMethod'
        ReturnShippingDestinationDetails:
          allOf:
            - $ref: '#/components/schemas/ReturnShippingDestinationDetails'
          description: >-
            The ReturnShippingDestinationDetails object contains all relevant
            details of the return destination.
    ReturnShippingMethod:
      type: object
      title: ReturnShippingMethod
      properties:
        ShippingMethodId:
          type: integer
          description: >-
            The shipping method identifier. Can be used when calling
            GetReturnDocuments to receive the return document for the selected
            shipping method.
        ShippingMethodDescription:
          type: string
          description: Description of the shipping method.
        ShippingMethodType:
          type: string
          description: Identifies the shipping method type.
        ShippingMethodTypeId:
          type: integer
          description: >-
            Identifies the return shipping type. Possible values: 1 -
            Self-postage (standard); 2 - Prepaid; 3 - Local Prepaid Courier; 4 -
            Local Prepaid; 5 - Consolidated. Can be used when calling
            GetReturnDocuments to receive the return document for the selected
            shipping method.
        ShipperName:
          type: string
          description: The name of the shipping service of the return provider.
        IsQrLabel:
          type: boolean
          description: Whether this is a label-free return (QR code only).
        IsTrackable:
          type: boolean
          description: Identifies whether this is a trackable return.
        Cost:
          type: number
          description: The cost of the shipment.
        Currency:
          type: string
          description: 3-letter currency ISO code.
    ReturnShippingDestinationDetails:
      type: object
      title: ReturnShippingDestinationDetails
      required:
        - Address
        - City
        - Country
        - Zip
      properties:
        Address:
          type: string
          description: Address for return shipping.
        City:
          type: string
          description: City for return shipping.
        Country:
          type: string
          description: Country for return shipping.
        Email:
          type: string
          description: Email for return shipping.
        Phone:
          type: string
          description: Phone for return shipping.
        Province:
          type: string
          description: Province for return shipping.
        State:
          type: string
          description: State for return shipping.
        Zip:
          type: string
          description: Zip for return shipping.

````