Coupons API

Discount coupon management. A free mock REST endpoint from DevSeed API for building and testing frontend applications without a real backend.

Base URL

https://www.devseedapi.com/api/v1/ecommerce

Endpoints

GET /ecommerce/coupons

Discount coupon management.

GET /ecommerce/coupons/:id

Returns a single record as { success, data }, or a 404 if the id doesn't exist. Supports the simulation parameters below.

Write endpoints (simulated)

POST /ecommerce/coupons
PUT /ecommerce/coupons/:id
PATCH /ecommerce/coupons/:id
DELETE /ecommerce/coupons/:id
  • Writes behave like a real API but nothing is saved: the response shows the record the write would produce, and later reads are unchanged.
  • Send JSON (Content-Type: application/json) with the same fields as a record. id and createdAt are set by the server and ignored if you send them.
  • POST returns 201. PUT needs a full record, PATCH only the fields to change (nested objects are merged), and DELETE returns the deleted record.
  • Invalid bodies return 422 with an errors list (missing or unknown fields, wrong types, ids that point at missing records). An unknown id returns 404. The simulation parameters work on writes too.

Query Parameters

ParameterTypeDescription
pagenumberPage number for pagination
limitnumberNumber of results per page
searchstringSearch across fields. Supports nested fields (e.g., searches name.first, name.last, email).
filterstringFilter by any field using query params. Supports nested fields using dot notation (e.g., address.city=Toronto, name.first=John).
sortstringSort by a field. Supports nested fields using dot notation (e.g., sortBy=name.first&order=asc).
delaynumber (ms)Simulates network latency
errornumber (HTTP code)Force a specific HTTP error
errorRatenumber (0–100)Random API failures by percentage
activebooleanFilter active coupons
codestringFilter by coupon code

Example Requests

Get all coupons

GET /ecommerce/coupons

Get one by ID

GET /ecommerce/coupons/cp1

Pagination

GET /ecommerce/coupons?page=2&limit=10

Search coupons

GET /ecommerce/coupons?search=john

Filter coupons

GET /ecommerce/coupons?filter=value

Sort coupons

GET /ecommerce/coupons?sortBy=field&order=asc

Create (simulated)

POST /ecommerce/coupons
Content-Type: application/json

{ ...fields of a coupons record }

Update fields (simulated)

PATCH /ecommerce/coupons/cp1
Content-Type: application/json

{ ...only the fields to change }

Delete (simulated)

DELETE /ecommerce/coupons/cp1

Simulate slow API

GET /ecommerce/coupons?delay=2000

Force an error

GET /ecommerce/coupons?error=500

Random API failures (20%)

GET /ecommerce/coupons?errorRate=20

Try the API

Live API Console

/ecommerce/coupons

Missing a field, filter or endpoint? Was this page helpful?

Request an endpoint / give feedback