🛒

returns

Product return request initiated by a customer. Tracks return reason, status, refund amount, request date, and processing completion date.

🎯 Request Builder

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

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

Endpoints

GET/returns

Get a collection of returns

Alternative: /commerce/returns
GET/returns/:id

Get a single return by ID

Alternative: /commerce/returns/:id
GET/returns/meta

Get resource metadata and schema

Alternative: /commerce/returns/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/returns?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/returns?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 returns
fetch('https://api.mockly.codes/returns?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the return request

Gen:random_int
order_idinteger

Foreign key reference to the original order being returned

Gen:random_int
reasonstring

Reason for the return (e.g., defective item, wrong size, not as described, changed mind)

Gen:sentence
statusstring

Current return status (e.g., requested, approved, in_transit, received, processed, rejected)

Gen:status
refund_amountnumber

Amount to be refunded to the customer for this return

Gen:price
requested_datestring

Timestamp when the customer requested the return

Gen:past_datedate-time
processed_datestring

Timestamp when the return was fully processed and refund issued

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