Refund properties
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the refund. |
| order_id | string | The ID of the order associated with the refund. |
| note | string | A note regarding the refund, provided by the merchant or system. |
| refund_price | string | The total refund amount as specified by the buyer, represented as a numeric string (e.g., "50.00"). |
| currency | string | The currency code for the refund amount (e.g., USD, EUR). |
| created_at | string | The timestamp when the refund was created. |
| updated_at | string | The timestamp of the last update to the refund. |
| refund_line_items | array of RefundLineItem | A list of line items included in the refund, detailing specific products and quantities. |
| payment_details | array of PaymentDetail | Details about the payment channels used for the refund. |
| refund_shipping | string | The shipping cost included in the total refund amount. |
| refund_shipping_tax | string | The tax amount applied to the refunded shipping cost. |
| refund_method | string | The method of the refund: |
- none: Unknown | ||
- general: Standard refund | ||
- customize: Custom refund method | ||
string | @Deprecated. | |
- pending: Refund is in progress | ||
- failed: Refund failed | ||
- finished: Refund successfully completed |
RefundLineItem
| Field | Type | Description |
|---|---|---|
| line_item_id | string | Unique identifier for the refund line item. |
| refund_quantity | integer | The number of units being refunded for this line item. |
| line_item | array of LineItem | Details of the original order line item associated with this refund. |
| tax | string | The tax amount applicable to the refunded goods. |
| discount | string | The refunded amount of any discounts applied to the goods. |
| sub_total | string | The total price of the product from the associated line_item. |
| total | string | The total refund amount for the goods, including discounts and taxes. |
| delete_quantity | string | The quantity of the product being refunded before it was shipped. |
PaymentDetail
| Field | Type | Desc |
|---|---|---|
| payment_channel | string | Refund payment channel |
| payment_method | string | Refund payment method |
| refund_price | string | Channel refund amount |
| finished_at | string | Refund Completion time RFC3339 Time does not exist is an empty string |