GetRefundDetails (Merchant to Global-e)

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.

The API returns:

MerchantOrderRefund
Credit note URL

Method/URL

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

Parameters

Response

Name	Type	Description
`MerchantOrderRefund`	Object Merchant.OrderRefund	Object containing details about the refundable amount for the order.

Merchant.OrderRefund

Parameter Name	Type	Description	Mandatory
`Components`	List of `Merchant.RefundComponent`	The list of `RefundComponent` objects for this order refund.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.	No
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	No
`MerchantRMANumber`	String	The Merchant’s Returned Merchandize Authorization Number	No
`OrderId`	String	Global‑e order unique identifier.	Yes
`OriginalTotalRefundAmount`	Decimal	The refund amount in the original Merchant currency including the local Merchant’s VAT (currency is specified in `CurrencyCode` property of the respective `Merchant.Order`).	Yes
`Products`	List of `Merchant.RefundProduct`	List of `RefundProduct` objects for this order refund.	No
`RefundComments`	String	Comments for the order refund	No
`RefundReason`	Object `Merchant.OrderRefundReason`	Reason for the order refund	No
`RMANumber`	String	The RMA number taken from the related Return.	No
`ServiceGestureAmount`	Decimal	The “Service gesture” amount in the customer’s currency is included in the `TotalRefundAmount`. “Service gesture” denotes any additional refund granted to the user, on top of the refund related to other components.	No
`TotalRefundAmount`	Decimal	The total refund amount in the end customer’s currency used for this order’s payment (currency is specified in InternationalDetails.`CurrencyCode`property for the respective `Merchant.Order`).	Yes
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store, as specified in the `WebStoreCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No

Merchant.OrderRefundReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order refund reason name.
`OrderRefundReasonCode`	String	Code denoting the order refund reason on the Merchant’s site (to be mapped on the Global‑e side). If not mapped, Global‑e internal code will be specified instead.

Merchant.RefundComponent

Parameter Name	Type	Description
`Amount`	Decimal	The refund amount in customer currency.
`ComponentType`	String	Products, Shipping, Duties, `PrepaidReturn` or `ServiceGesture`.
`IsChargedToMerchant`	Boolean	Indicates if the component is charged to the Merchant or to Global-e. TRUE - Component is charged to the Merchant (default) FALSE - Component is charged to Global‑e If the same component is split between charged to the Merchant and charged to Global‑e, it should appear twice, each time with a different value in `IsChargedToMerchant`. Exception: A component `PrepaidReturn` – it should always be `IsChargedToMerchant` = TRUE.
`OriginalAmount`	Decimal	The refund amount in Merchant currency.

Merchant.RefundProduct

Parameter Name	Type	Description	Mandatory
`CartItemID`	String	Identifier of the line item on the Merchant’s site. This property is mandatory and should be equal to the respective Product’s `CartItemId` originally specified in the `SendCart` API for the order being refunded	Yes
`OriginalRefundAmount`	Decimal	The refund amount in the original Merchant currency including the local Merchant’s VAT for this product line item, before applying any price modifications (i.e. part of or the full value paid by Global-e to the Merchant, as was specified in `Merchant.Product.Price` for the respective order.
`ProductCode`	String	Product SKU or Product Variant ID according to merchant configuration. Can be used as a Product Identifier instead of `CartItemId`. If there are multiple products with the same identifier, we choose one of them arbitrarily.	No
`RefundAmount`	Decimal	The refund amount for this product line item in customer currency used for the payment of this order
`RefundComments`	String	Comments for this product’s refund	No
`RefundQuantity`	Decimal	Product quantity (i.e. a part of the originally ordered quantity) that the refund refers to
`RefundReason`	Object `Merchant.OrderRefundReason`	Reason for this product’s refund	No
`Sku`	String	This field is obsolete. Use `ProductCode` instead.	No

Merchant.OrderRefundReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order refund reason name.
`OrderRefundReasonCode`	String	Code denoting the order refund reason on the Merchant’s site (to be mapped on the Global‑e side). If not mapped, Global‑e internal code will be specified instead.

Errors

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.

Examples

Response

{
  "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

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

Documentation Portal

GetRefundDetails (Merchant to Global-e)

Parameters

Merchant.OrderRefund

Merchant.OrderRefundReason

Merchant.RefundComponent

Merchant.RefundProduct

Merchant.OrderRefundReason

Errors

Examples

Search results