Refund Methods

GetRefundDetails

This API provides information about refunds associated with an order. The information includes all the refund details and the refundable amount for each product in the order.

Method/URL

GET https://{globale_api_domain}/v1/orders/{orderId}/refunds

Response Parameters

Name	Type	Description
`MerchantInternalOrderId`	String	Unique internal order identifier on the merchant's site.
`MerchantOrderID`	String	Unique order identifier on the merchant’s site.
`OrderID`	String	Unique Global‑e order identifier.
`RefundableAmount`	Class RefundableAmount	Object containing details about the refundable amount for the order.
`Refunds`	Class Refunds	Object containing details about the order refunds.
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store.
`WebStoreInstanceCode`	String	Code used on the Merchant’s side to identify the web store instance.

Examples

Response Example

{
  "OrderId": "string",
  "MerchantOrderId": "string",
  "MerchantInternalOrderId": "string",
  "WebStoreCode": "string",
  "WebStoreInstanceCode": "string",
  "Refunds": [
    {
      "RefundID": "string",
      "RMANumber": "string",
      "MerchantRMANumber": "string",
      "FullRefund": true,
      "ProductsDutiesRefund": true,
      "ShippingRefund": true,
      "RefundAsGiftCard": null,
      "TotalRefundAmount": "string",
      "OriginalTotalRefundAmount": "string",
      "ServiceGestureAmount": "string",
      "TotalMoneyRefundAmount": "string",
      "DutiesAmount": "string",
      "ShippingAmount": "string",
      "CustomerPrepaidRefundAmount": "string",
      "OriginalCustomerPrepaidRefundAmount": "string",
      "TotalGiftCardsRefundAmount": "string",
      "TotalGiftCardsRefundAmountinMerchantCurrency": 0,
      "TotalLoyaltyPointsRefunded": 0,
      "TotalLoyaltyPointsRefundAmount": 0,
      "GiftCardsData": [
        {
          "CardId": 0,
          "OtherFields": "..."
        }
      ],
      "ExternalReference": "string",
      "InitiatedBy": "string",
      "CurrencyCode": "string",
      "OriginalCurrencyCode": "string",
      "RefundReason": {
        "OrderRefundReasonCode": "string",
        "Name": "string"
      },
      "RefundProducts": [
        {
          "CartItemId": "string",
          "RefundQuantity": "string",
          "RefundAmount": "string",
          "OriginalRefundAmount": "string",
          "RefundAmountPercent": "string",
          "RefundReason": "string",
          "RefundComments": "string",
          "Sku": "string",
          "ProductCode": "string",      
          "productGroupCode": "string",            
          "ProductCodeSecondary": "string",
          "productGroupCodeSecondary": "string"      
        }
      ],
      "RefundComponents": [
        {
          "Amount": "string",
          "OriginalAmount": "string",
          "IsChargedToMerchant": "string",
          "ComponentType": "string"
        }
      ],
      "RefundComments": "string",
      "RefundDocument": [
        {
          "DocumentData": "string",
          "CreditNoteUrl": "string",
          "DocumentTypeCode": "string",
          "DocumentTypeName": "string",
          "DocumentExtension": "string"
        }
      ]
    }
  ],
  "RefundableAmount": {
    "CurrencyCode": "string",
    "TotalCreditAmount": 0,
    "RefundableShippingAmount": 0,
    "RefundableDutiesAmount": 0,
    "ProductRefundableAmount": [
      {
        "CartItemId": "string",      
        "Sku": "string", 
        "ProductCode": "string",      
        "productGroupCode": "string",            
        "ProductCodeSecondary": "string",
        "productGroupCodeSecondary": "string",        
        "RefundableTotalAmount": 0,
        "RefundableQuantity":1
      }
    ]
  }
}

Error Response

{
   "error": {
        "code": "String",
	"message": "String",
	"description": "String"	
   }
}

Error Codes

Code	Description
400	Bad Request. Information cannot be parsed or violates Global-e policies. For example: Order ID not found.
500	Request was successfully parsed with no violations detected, but there was a failure during request handling.

Code

Description

400

Bad Request.

Information cannot be parsed or violates Global-e policies. For example: Order ID not found.

500

Request was successfully parsed with no violations detected, but there was a failure during request handling.

Documentation Portal

Refund Methods

GetRefundDetails

Search results