Refund Methods
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 |
---|---|---|
| Object Merchant.OrderRefund | Object containing details about the refundable amount for the order. |
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. |
Objects for GetRefundDetails API
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" } }