refund_status's mode
There's two mode for order's
refund_status
:customize
andgeneral
. If there's no refund issued, order'srefund_status
isnull
.How to issue a
customize
type partial refund?
create a partial refund withprice
only params.How to issue a
general
type partial refund?
create a partial refund withline_items
only params.while calling this API, you should choose either refunded with
price
or refundedline_items
, but not both!once you issue a partial refund with
price
only, therefund_status
will assigned ascustomize
, and you can't issue partial refund withline_items
anymore.
if you issue a partial refund withline_items
only, therefund_status
will assigned asgeneral
, and you can issueline_items
partial refund later on again, orprice
type partial refund as well, but once you issue aprice
one, this order'srefund_status
will change fromgeneral
tocustomize
, and can't be rollback anymore.
Noted on this API:
- while refund by
line_items
, refunded amount is calculated automatically based on refunded items:
refunded amount = product's sales price x refund quantity - pro-rated refundable discount amount x refund quantity + pro-rated refundable tax x refund quantity
- if you refund by
line_items
, refund quantity can not exceed line items's remain refundable quantity. - if you refund by
price
, price params can't exceed current refundable amount. - if you need to return the fulfillments, please specify
is_return
as true. - shipping fee is refunded while the last line_items is refunded.