🔒 Requires write_order access scope. More access scope
The Order Refund API processes order refunds, supports product selection, supports setting refund amounts for shipping and other charges, and supports specifying payment channels and refund amounts.
📘 Public Request Parameters
Parameter Type Required Description Example idstring Yes The unique ID of the order. 1232123
Field
Type
Required
Example
Description
order_idstring
yes
ORD12345Order ID
refund_totalstring
yes
100.00The total refund amount. If refund_payments are specified, this value must equal the sum of all refund_payments amounts.
refund_shipping_totalstring
no
10.00The total shipping amount to be refunded.
refund_tipstring
no
5.00The tip amount to be refunded.
refund_additional_totalstring
no
15.00The total amount for additional refunded charges.
refund_product_totalstring
no
70.00The total refund amount for the refunded products.
refund_line_itemsarray of LineItem
no
[{"line_item_id": "LI123", "quantity": 2}]The items being refunded. Refund items. See LineItem for details.
refund_paymentsarray of RefundPayment
no
[{"payment_line_id": "PAY123", "refund_price": "50.00"}]The payment methods used for the refund. See RefundPayment for details.
refund_additional_pricesarray of RefundAdditionalPrices
no
[{"name": "Handling Fee", "price": "5.00"}]Additional charges included in the refund. See RefundAdditionalPrices for details.
notestring
no
Refund for damaged itemsRemark
Field Type Example Description line_item_idstring LI123Refund item ID quantityinteger 2Refund quantity waiting_ship_quantityinteger 1The refund quantity of waiting shipping goods return_inventoryboolean trueWhether to return inventory
Field Type Example Description namestring Handling FeeAdditional price name pricestring 5.00Additional price refund amount
Field Type Example Description payment_line_idstring PAY123Refund payment channel ID refund_pricestring 50.00Refund amount
📘 Public Response Parameters
Field Type Example Description codestring SUCCESSError code messagestring Refund processed successfullyError message dataobject { "refund_record_id": "R12345", "post_sale_id": "A67890" }Order refund response data. See RefundOrderResponse_Data for details.
Field Type Example Description refund_record_idstring R12345Refund record ID post_sale_idstring A67890After-sales ID
Field Type Description Example codestring The error code indicating the type of issue. InvalidParametermessagestring A detailed message describing the error. Order id is required.
Status Code Message Possible Reason Example Response 400 Bad Request Invalid input format or request structure (e.g., missing required fields or incorrect data types). Bad RequestUnauthorized The request is missing valid authentication credentials or the credentials provided are invalid. Unauthorized422 InvalidParameter The argument does not pass an order id { "code": "InvalidParameter", "message": "Order id is required." }
