Refund List

๐Ÿ”’

Requires read_order access scope. More access scope

Response Description

๐Ÿ“˜

The relationships between entities.

Refund properties

FieldTypeDesc
idstring
order_idstringOrder ID
notestring
refund_pricestringtotal refund amount by buyer input
currencystring
created_atstring
updated_atstring
refund_line_itemsarray of RefundLineItem
payment_detailsarray of PaymentDetail
refund_shippingstringShipping included in the refund amount
refund_shipping_taxstringShipping tax is included in the refund amount
refund_methodstringRefund method:
none - Unknown๏ผŒ
general -
customize -
refund_statusstringRefund status:
pending -
failed -
finished -

RefundLineItem

FieldTypeDesc
line_item_idstringrefund line item id
refund_quantityintegerQuantity to be refunded
line_itemarray of LineItemOrder line items
taxstringContributory tax on goods to be returned
discountstringActual refund of discount charges on goods
sub_totalstringTotal price of product of line_item
totalstringThe actual refund of the amount paid for the goods
delete_quantitystringQuantity for refund before shipping.

PaymentDetail

FieldTypeDesc
payment_channelstringRefund payment channel
payment_methodstringRefund payment method
refund_pricestringChannel refund amount
finished_atstringRefund Completion time RFC3339 Time does not exist is an empty string
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!