Miva icon

Miva

Interact with Miva eCommerce API

Get Products

AI-generated

Summary

Fetches a list of products from a specified Miva store, supporting pagination and selective field retrieval including optional custom fields.

Inputs

  • Store Code (required) — The Miva store code identifier to specify which store to fetch products from.
  • Count — Total number of product records to retrieve (default is 100).
  • Batch Size — Number of product records to fetch per API call (default is 100).
  • Offset — Base offset for starting record retrieval, added to the pagination offset (default is 0).
  • Return Fields — Select specific product fields to return in the response; can include on-demand fields for additional product details.
  • Include Custom Fields — Boolean flag to indicate whether custom field values should be included in the returned product data.

Output shape

a list of product objects

Returns up to the specified count of products from the given store, retrieved in batches according to batch size and offset parameters. Each product object includes only the selected fields. If no products are found, a single message item is returned indicating no results. Errors are handled according to node configuration with standard error envelopes.

Examples

Example 1: Retrieve the first 50 products from a Miva store with store code 'yt2', returning only the product ID, name, and price fields, excluding custom fields.

Set 'Store Code' to 'yt2', 'Count' to 50, select 'id', 'name', and 'price' in 'Return Fields', and leave 'Include Custom Fields' as false.

Example 2: Fetch 200 products in batches of 100, including custom fields and on-demand details like categories and product inventory.

Set 'Store Code' to target store, 'Count' to 200, 'Batch Size' to 100, select desired on-demand fields with 'Return Fields', and set 'Include Custom Fields' to true.

Links

Discussion