Utilities
Echo
Test request/response
Status
Generate HTTP status codes
Delay
Test response delays
Middleware
Test middleware parameters
Chaos
Chaos engineering tests
Resources
Browse Resources
Test 100+ API endpoints
Playground/Resources/Promotion

promotions

commerce

Marketing promotion or sale campaign offering percentage discounts. Contains promotion details, discount percentage, active period, and status for promotional campaigns.

Request Builder

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

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

Endpoints

GET/promotions

Get a collection of promotions

Alternative: /commerce/promotions
GET/promotions/:id

Get a single promotion by ID

Alternative: /commerce/promotions/:id
GET/promotions/meta

Get resource metadata and schema

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

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/promotions?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

curl "https://api.mockly.codes/promotions?page=1&limit=10&count=10"

Examples reflect your current request builder settings.

Schema Properties

idinteger

Unique identifier for the promotion

Gen:random_int
titlestring

Promotional title or campaign name (e.g., Summer Sale, Black Friday, Holiday Special)

Gen:sentence
descriptionstring

Detailed description of the promotion, terms, and eligible products

Gen:paragraph
discount_percentagenumber

Discount percentage offered (typically 5-50%)

Gen:float
start_datestring

Date when the promotion becomes active

Gen:past_datedate
end_datestring

Date when the promotion expires

Gen:future_datedate
activeboolean

Whether the promotion is currently active and available

Gen:boolean

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