🛒

inventory

Stock inventory record tracking product availability, quantities, reserved items, and warehouse location. Used for inventory management and stock level monitoring.

🎯 Request Builder

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

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

Endpoints

GET/inventories

Get a collection of inventory

Alternative: /commerce/inventories
GET/inventories/:id

Get a single inventory by ID

Alternative: /commerce/inventories/:id
GET/inventories/meta

Get resource metadata and schema

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

2. Search Specific Fields

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

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the inventory record

Gen:random_int
product_idinteger

Foreign key reference to the product this inventory record belongs to

Gen:random_int
skustring

Stock Keeping Unit - unique identifier for the specific product variant

Gen:uuid
quantityinteger

Current available stock quantity for this product

Gen:random_int
reservedinteger

Number of units reserved for pending orders or holds

Gen:random_int
locationstring

Warehouse or storage location where this inventory is stored

Gen:city
last_updatedstring

Timestamp when the inventory quantity was last updated

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