OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Order Summary

AI-generated

Summary

Retrieve an order summary from the OnPrintShop Complete API, with optional filters for customer reference, date range, grouping, order status, and order ID. Choose which summary and nested order fields to return; Safe Mode blocks mutations, and this read operation does not intentionally change records.

Inputs

  • Safe Mode — Enable to block mutations in Complete API; this operation is read-only.
  • Input Mode — Choose Fields to configure API arguments through the Parameters collection, or JSON Object to provide an Arguments JSON object.
  • Parameters — Optional API arguments: customer_reference, from_date, to_date, group_by (Daily, Weekly, Monthly, or Yearly), limit, offset, order_status, and orders_id.
  • Arguments JSON — In JSON Object mode, provide the API arguments as a JSON object.
  • Order Summary.orders Parameters — Optional nested order-list filters: customer_email, customer_id, from_date, to_date, limit, offset, order_product_status, order_status, order_type (Lt or Gt), orders_id, orders_products_id, and store_id.
  • Return Fields Mode — Return all available fields or select a custom subset.
  • Return Fields — In Custom Selection mode, select summary values, order summary fields, nested orders and their customer, product, address, and shipment details, and count fields.

Output shape

A list of items containing the requested order summary response.

The response can include summary totals and an orders collection with nested order details; returned fields depend on the selection. API pagination behavior is not specified by the supplied source.

Examples

Example 1: Retrieve monthly totals for a date range

Set Group By to Monthly, provide From Date and To Date, and optionally set order status and pagination arguments. Use Return Fields to limit the summary and nested order data.

Links

Discussion