Retrieve the refunds in the eCommerce system for the specified order

https://cloud-elements.com/orders/{orderId}/refunds

Access Token Required: API Key

Path Parameters

orderIdstringrequired

The ID of the order to retrieve refunds from in the eCommerce system

Query Params

pageSizestring

The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned

nextPagestring

The next page cursor, taken from the response header: `elements-next-page-token`

fieldsstring

The fields to return on the response. Can be a single field or a comma-separated list of fields

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://cloud-elements.com/orders/{orderId}/refunds' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET