get https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders/refund_records
Requires
read_orderaccess scope. More access scope
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
order_ids | string | Optional | Comma-separated order IDs. A maximum of 10 IDs are supported. |
refund_record_ids | string | Optional | Comma-separated refund record IDs. A maximum of 20 IDs are supported. |
refund_status | string | Optional | Comma-separated refund statuses. Supported values: pending, finished, failed. |
page | string | Optional | Page number for pagination. |
per_page | string | Optional | Number of records per page. Maximum: 100. |
sort_by | string | Optional | Sort records by field. Supported values: created_at, updated_at. |
sort_direction | string | Optional | Sorting order. Supported values: asc, desc. |
created_at_start | string | Optional | Filter records created at or after this date (ISO 8601 format). |
created_at_end | string | Optional | Filter records created at or before this date (ISO 8601 format). |
updated_at_start | string | Optional | Filter records updated at or after this date (ISO 8601 format). |
updated_at_end | string | Optional | Filter records updated at or before this date (ISO 8601 format). |
Response Description
Public Response Fields
Successful Response
| Field | Type | Description |
|---|---|---|
| records[] | array of refund object | |
| records[].id | string | Unique identifier for the refund. |
| records[].order_id | string | The ID of the order associated with the refund. |
| records[].note | string | A note regarding the refund, provided by the merchant or system. |
| records[]refund_price | string | The total refund amount as specified by the buyer, represented as a numeric string (e.g., "50.00"). |
| records[].currency | string | The currency code for the refund amount (e.g., USD, EUR). |
| records[].created_at | string | The timestamp when the refund was created. |
| records[].updated_at | string | The timestamp of the last update to the refund. |
| records[].refund_line_items | array of RefundLineItem | A list of line items (products) included in the refund, detailing specific products and quantities. |
| records[].payment_details | array of PaymentDetail | Details about the payment channels used for the refund. |
| records[].refund_shipping | string | The shipping cost included in the total refund amount. |
| records[].refund_shipping_tax | string | The tax amount applied to the refunded shipping cost. |
| records[].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 | 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 |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| ErrorCode | Description | Possible reasons |
|---|---|---|
| 422 | StatusUnprocessableEntity | 1:The shipping address does not pass;ShippingAddress is nil. 2:Get transaction settings error;not exists checkout setting 3:Failed to create order line items;record_not_found 4:create_order_calculate_failed;order price calculate error 5:create_order_build_failed;customer or paymentline information error 6:order_id {order_id} CreateOrderBatchOption failed 7:Get Order Detail failed 8:DecreaseInventory failed |
| 406 | Create order failed | |
| 500 | StatusInternalServerError | Aborted/NotFound/Unimplemented/Unauthenticated/DeadlineExceeded |