🛒

discounts

Discount rule or promotion that can be applied to orders. Tracks discount code, type, value, eligibility requirements, usage limits, and expiration.

🎯 Request Builder

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

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

Endpoints

GET/discounts

Get a collection of discounts

Alternative: /commerce/discounts
GET/discounts/:id

Get a single discount by ID

Alternative: /commerce/discounts/:id
GET/discounts/meta

Get resource metadata and schema

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

2. Search Specific Fields

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

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the discount

Gen:random_int
codestring

Unique discount code or identifier used to apply the discount

Gen:uuid
typestring

Type of discount (e.g., percentage, fixed_amount, buy_one_get_one)

Gen:word
valuenumber

Discount value - percentage (5-100) or fixed amount depending on type

Gen:float
minimum_purchasenumber

Minimum order value required to qualify for this discount

Gen:price
max_usesinteger

Maximum number of times this discount can be redeemed

Gen:random_int
used_countinteger

Current number of times this discount has been used

Gen:random_int
expires_atstring

Date when the discount expires and is no longer valid

Gen:future_datedate

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