Documentation Portal

The following attributes are required in the system (OMS/ERP/MW) executing the Refunds calls:

CreateOrderRefund (OrderRefundDetails orderRefund, List<RefundProduct> refundProductsList)

Issues refund for the order specified in orderRefund argument.

Optionally may include the list of RefundProducts or components (service gesture, shipping or duties&taxes) to refund for.

Total refund amounts

If orderRefund.TotalRefundAmount is not specified, it will be converted to the end customer’s currency based on RefundAmount or OriginalRefundAmount values for the RefundProducts in refundProductsList and their respective Product VAT rates.

For Full order refunds

If orderRefund.FullRefund is specified as true:

For Partial order refunds

If product.RefundAmount AND product.OriginalRefundAmount are not specified then:

API Endpoint: CreateOrderRefund

POST request URL: https://connect.bglobale.com/Order/CreateOrderRefund?merchantGUID=abcdabcd-abcd-abcd-abcd-abcdabcdabcd

Call parameters

MerchantGUID: Unique Merchant Identifier and API token Different for Test and Live environments.

OrderRefund

RefundProduct list body [array]

SAMPLES

Examples in this section are descriptive and may involve redundancy in attribute declaration.

Parameters: OrderRefund

{
    "OrderId": "GE95135467GB",
    "TotalRefundAmount": "60.95",
    "RefundReason": {
        "OrderRefundReasonCode": 8,
        "Name": "Damaged Item"
    },
    "RefundComments": "Damaged shipment but the customer kept it"
}

Body: RefundProductList with List<RefundProduct>

[{
        "CartItemId": "1381109",
        "RefundQuantity": "1",
        "RefundAmount": "60.95",
        "RefundReason": {
            "OrderRefundReasonCode": 8,
            "Name": "Damaged Item"
        },
        "RefundComments": "Damaged shipment but the customer kept it"
    }
]

If success: OrderRefundInfo

Merchant.OrderRefund

Merchant.RefundProduct

Merchant.RefundComponent

Merchant.OrderRefundReason

If failure: ErrorInfo

Success response: OrderRefundInfo

{
    "Success": true,
    "Reason": "Refund generated with id 67961",
    "NotifyOrderRefund": {
        "MerchantOrderId": "orderid123",
        "RefundId": "67961",
        "MerchantGUID": "39a4ffdsfds-f6324b-41ce-afdsfa-c8ef18234132",
        "Products": [
            {
                "CartItemId": "2",
                "RefundQuantity": "1",
                "OriginalRefundAmount": "31.2707",
                "RefundAmount": "60.9500",
                "RefundReason": {
                    "OrderRefundReasonCode": null,
                    "Name": "Undefined"
                },
                "RefundComments": "Damaged shipment but the customer kept it"
            }
        ],
        "Components": [
            {
                "Amount": "60.95",
                "OriginalAmount": "31.27",
                "IsChargedToMerchant": "TRUE",
                "ComponentType": "Products"
            }
        ],
        "OrderId": "GE95135467GB",
        "TotalRefundAmount": "60.95",
        "RefundReason": {
            "OrderRefundReasonCode": null,
            "Name": "Undefined"
        },
        "RefundComments": "Damaged shipment but the customer kept it",
        "OriginalTotalRefundAmount": "31.27",
        "ServiceGestureAmount": "0",
        "WebStoreCode": null,
        "WebStoreInstanceCode": "GlobalEDefaultStoreInstance",
        "FullRefund": false
    }
}

General API error as ErrorInfo:

{
    "Code": "error code",
     "Error": "error message",
     "Description": "error description"
}

Object processing error as OrderRefundInfo: (Reason is optional)

{
     "Success": false,
     "Reason": "Processing error detail",
     "NotifyOrderRefund": null
}

For full order refunds, no refund value is required. Global‑e will establish it from order. This will include Shipping as well as Duties & Taxes.

 {
     "OrderId": "GE95135467GB",
    "FullRefund": true
}

For full product refunds, no refund value is required. Global‑e will establish it from order.

{
    "OrderId": "GE95135467GB"
}

[
    {
        "CartItemId": "1381109",
        "RefundQuantity": 2
    },
    {
        "CartItemId": "2371567",
        "RefundQuantity": 1
    }
]

For partial product refunds, a refund value is required. It should be provided:

The total amount of refund is expected in parameters if amounts are provided.

{
     "OrderId": "GE95135467GB",
    "TotalRefundAmount": "320"
}

[
     {
        "CartItemId": "1381109",
        "RefundQuantity": null,
         "RefundAmount": "320"
    }
]

{
     "OrderId": "GE95135467GB"
}

[
    {
        "CartItemId": "1381109",
        "RefundQuantity": null,
        "RefundAmountPercent": "50"
    }
]

For components refunds, customer currency value is required.

The total amount of refund is expected in the parameters for input control.

{
    "OrderId": "GE95135467GB",
    "ShippingAmount": "10",
    "TotalRefundAmount": "10"
}

[]

[]

[]

In such a scenario, the Duties&Taxes would not necessarily be expected to be refunded, in which the refund must not be triggered as a full order refund (which would include D&T).

Example order for these sections goes as follows:

Item is refunded in full thus amount is not required, only for shipping.

[
     {
        "CartItemId": "1381109",
        "RefundQuantity": 2
    }
    ]

Example: A German shopper is returning an item to a US merchant.

The return shipping cost is €5.00 so the merchant deducts €5.00 from the refund.

{
     "OrderId": "#4999",
     "CustomerPrepaidRefundAmount":5
}

[ 
    {
        "CartItemId":"12935475658836",
        "RefundQuantity":"1",
        "RefundComments":"02-Wrong Product"
    }
]

ErrorInfo

ResponseInfo

For the validations below, we do not return an ErrorInfo object but a different object – ResponseInfo.