🛒

refunds

Refund transaction record for returning money to a customer. Tracks refund amount, reason, status, processing date, and associated order.

🎯 Request Builder

https://api.mockly.codes/refunds?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/refunds

Get a collection of refunds

Alternative: /commerce/refunds
GET/refunds/:id

Get a single refund by ID

Alternative: /commerce/refunds/:id
GET/refunds/meta

Get resource metadata and schema

Alternative: /commerce/refunds/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/refunds?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/refunds?q=laptop&search_fields=name,description

💡 Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 refunds
fetch('https://api.mockly.codes/refunds?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/refunds?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/refunds?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/refunds?nocache=true')

Schema Properties

idinteger

Unique identifier for the refund record

Gen:random_int
order_idinteger

Foreign key reference to the order this refund is associated with

Gen:random_int
amountnumber

Refund amount to be returned to the customer

Gen:price
currencystring

ISO currency code for the refund amount (e.g., USD, EUR, GBP)

Gen:currency
reasonstring

Reason for the refund (e.g., defective product, wrong item, customer request)

Gen:sentence
statusstring

Current refund status (e.g., pending, processing, completed, cancelled)

Gen:status
processed_datestring

Timestamp when the refund was processed and funds were returned

Gen:past_datedate-time

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request