Miva icon

Miva

Interact with Miva eCommerce API

Get Orders

AI-generated

Summary

Retrieve a list of orders from a specified Miva store, optionally filtering by an order queue, and customize the fields and item structure in the returned data.

Inputs

  • Queue Filter — Optionally filter orders by a specific queue; choose 'No Filtering' or 'Filter by Order Queue'.
  • Queue Code (required) — Code of the order queue to filter by; required if filtering by queue.
  • Store Code (required) — The Miva store code identifier to fetch orders from.
  • Count — Total number of order records to fetch; defaults to 100.
  • Batch Size — Number of records to fetch per API call; defaults to 100.
  • Offset — Base offset index to start fetching records from; defaults to 0.
  • Return Fields — Select the order fields to include in the response; includes standard and on-demand fields such as billing, shipping, payment, and customer info.
  • Item Fields — If including 'items' in Return Fields, select which item-specific fields to include within each order.
  • Flatten Items — If 'items' are included in the response, choose whether to flatten each order item into its own row or keep items nested within orders.

Output shape

a list containing the requested order records, optionally flattened by order items if specified

The response returns an array of order objects with only selected fields. When 'items' field is included and flattening is enabled, each item in an order produces a separate output row with combined order and item fields. Pagination is handled internally based on Count and Batch Size parameters. Errors throw a node operation error unless 'Continue On Fail' is enabled, which returns error information in the output.

Links

Discussion