OnPrintShop Orders icon

OnPrintShop Orders

Read and update OnPrintShop orders, order products, shipments, batches, quotes, and statuses

Complete API → Orders

AI-generated

Summary

Read OnPrintShop orders using the Complete API, with optional filters, pagination, and selectable response fields. This operation is presented as read-only and does not intentionally change records.

Inputs

  • Input Mode — Choose Fields to set parameters individually, or JSON Object to provide Arguments JSON.
  • Parameters — Optional API filters and paging arguments: customer email or ID, from/to dates, limit, offset, order product status, order status, order type (Lt or Gt), order ID, order product ID, and store ID.
  • Arguments JSON — In JSON Object mode, supply the API arguments as a JSON object.
  • Pagination — Off preserves the API limit and offset. All Records fetches additional pages; Limit Records fetches pages up to Max Records.
  • Page Size — Maximum records per request when pagination is enabled; replaces the API limit parameter.
  • Page Delay (Ms) — Delay between page requests when pagination is enabled.
  • Max Pages — Safety limit for paginated requests. Reaching it before pagination completes fails instead of returning partial results.
  • Max Records — Record cap used with Limit Records pagination.
  • Return Fields Mode — Return all available fields or select specific fields.
  • Return Fields — Fields to include when Custom Selection is chosen, covering order, customer, address, product, shipment, and count data.

Output shape

A response containing order data and available count fields.

The UI offers All Fields or Custom Selection, with selectable paths including currentCount, orders, and totalOrders. The supplied source pack shows only the operation class wiring; it does not expose response shaping or pagination implementation details.

Links

Discussion