OnPrintShop Orders icon

OnPrintShop Orders

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

Complete API → Get Batch

AI-generated

Summary

Retrieves batch data from the OnPrintShop Complete API. Provide arguments as individual fields or a JSON object, then choose which response fields to return.

Inputs

  • Safe Mode — Defaults to false. The Complete API blocks mutations when enabled; this operation is described as reading API data without intentionally changing records.
  • Input Mode — Choose Fields (default) to enter parameters individually, or JSON Object to provide the API arguments as JSON.
  • Parameters — In Fields mode, optionally provide Batch ID (integer), Limit (integer), Offset (integer), or Search (string).
  • Arguments JSON — In JSON Object mode, provide the API arguments. Defaults to an empty object.
  • Return Fields Mode — Choose All Fields (default) or Custom Selection to control the returned fields.
  • Return Fields — In Custom Selection mode, select fields such as batch details, current count, and total batch details.

Output shape

API response data, optionally restricted to selected fields.

The properties list names batch detail fields (including ID, batch name, jobs, print and finishing instructions, filenames, image links, and nesting dimensions), currentCount, and totalBatchDetails. The source pack shows only the node entry module, so it does not establish the exact response envelope or how each argument is applied.

Links

Discussion