Actions65
- Order Actions
- Product Actions
- Store Shipping Account Actions
- Delivery Companies API Actions
- Team User Actions
- Store Actions
- State Actions
- Stop Desk Actions
- City Or Municipality Actions
- Store Client Actions
- Store Coupon Actions
- Store Pro Stock Actions
Store Pro Stock → Get Many
AI-generatedSummary
Retrieve multiple stock records for a specific store in the Dukan e-commerce platform, applying optional filters, pagination, sorting, and field selection to customize the data returned.
Inputs
- Target Store ID (required) — The MongoDB ObjectId of the store whose stock records to retrieve.
- Page Number — Page number to retrieve in paginated results, minimum value 1, default is 1.
- Limit — Maximum number of stock records to return, minimum 1, default is 50.
- Sort — Fields to sort the returned stock records by, supporting single or space-separated fields, with optional prefix '-' for descending order; default is '-createdAt'.
- Populate Fields — Space-separated list of fields to populate with referenced data in the returned stock records.
- Select Fields — Space-separated list of fields to include in the returned stock records.
- Offset — Number of stock records to skip from the beginning, default is 0.
- Filter — JSON string representing a MongoDB query filter to apply when retrieving stock records; defaults to an empty filter (i.e., all records).
- Force Custom Auth Header — If enabled, uses the Custom API Key from this node instead of credentials for authenticating API requests.
- Force Custom Base URL — If enabled, uses the Custom Base URL from this node instead of the base URL in the credentials.
- Custom API Key — Custom API key to use when 'Force Custom Auth Header' is enabled.
- Custom Base URL — Custom Base URL to use when 'Force Custom Base URL' is enabled; should exclude the /v1/external suffix.
- Request Options — Optional collection of advanced request settings such as batching, proxy, timeout, and SSL certificate handling.
Output shape
a list of stock records matching the specified store and filter criteria
Supports pagination with page and limit parameters. The returned stock records can be filtered, sorted, and customized with select and populate fields. Errors in filter JSON or API authorization will result in request failure.
Examples
Example 1: Retrieve first 20 stock items of a store sorted by creation date descending
Set 'Target Store ID' to the store's ObjectId, 'Limit' to 20, 'Page Number' to 1, and use default sorting.