🛒

wishlists

Customer wishlist containing products they want to purchase later. Supports named wishlists, public/private visibility, and multiple items. Used for gift registries and saved-for-later functionality.

🎯 Request Builder

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

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

Endpoints

GET/wishlists

Get a collection of wishlists

Alternative: /commerce/wishlists
GET/wishlists/:id

Get a single wishlist by ID

Alternative: /commerce/wishlists/:id
GET/wishlists/meta

Get resource metadata and schema

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

2. Search Specific Fields

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

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the wishlist

Gen:random_int
user_idinteger

Foreign key reference to the user who owns this wishlist

Gen:random_int
namestring

Name or title of the wishlist (e.g., Birthday Wishlist, Wedding Registry, My Favorites)

Gen:sentence
itemsarray

Array of product identifiers or names saved in this wishlist

Gen:tags
is_publicboolean

Whether the wishlist is publicly visible and shareable, or private to the user

Gen:boolean
created_atstring

Timestamp when the wishlist was created

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