Actions57
- Batch Actions
- Mutation Actions
- Order Actions
- Order Detail Actions
- Order Product Actions
- Order Shipment Actions
- Quote Actions
- Quote Product Actions
- Ship To Multiple Actions
- Status Actions
- Complete API Actions
- Get Batch
- Get Quote
- Order Billing Details
- Order Blind Details
- Order Delivery Details
- Order Products
- Order Shipment Details
- Order Status
- Order Summary
- Orders
- Quoteproduct
- Ship To Multiple Address
- Modify Order Product
- Set Batch
- Set Batch Job
- Set Order
- Set Order Product
- Set Order Product Image
- Set Order Product Image From URL
- Set Product Design
- Set Quote
- Set Shipment
- Update Order Status
Complete API → Order Summary
AI-generatedSummary
Retrieves an Order Summary from the OnPrintShop Complete API. Choose field-based parameters or supply an Arguments JSON object; the operation also exposes nested order filters and lets you select which response fields to return.
Inputs
- Safe Mode — Boolean, default false. The UI describes this as blocking mutations in Complete API; this operation is presented as a read and does not intentionally change records.
- Input Mode — Choose Fields or JSON Object to provide API arguments.
- Parameters — In Fields mode, optional customer_reference, from_date, group_by (Daily, Weekly, Monthly, or Yearly), limit, offset, order_status, orders_id, and to_date.
- Arguments JSON — In JSON Object mode, provide the API arguments as a JSON object.
- Order Summary.orders Parameters — Optional nested orders filters: customer_email, customer_id, from_date, limit, offset, order_product_status, order_status, order_type (lt or gt), orders_id, orders_products_id, store_id, and to_date.
- Return Fields Mode — Choose All Fields or Custom Selection.
- Return Fields — In Custom Selection mode, choose from the listed summary, nested order, and pagination or total fields.
Output shape
A single API response object containing the order summary and, where returned, nested orders and totals.
Available response fields include summary counts and amounts, grouping duration, and detailed order, customer, product, billing, delivery, and shipment data. Custom Selection controls which listed fields are returned. Runtime implementation details are not present in the supplied source pack, so exact response shape and parameter handling are not confirmed there.