OnPrintShop Orders icon

OnPrintShop Orders

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

Batch → Get Many

AI-generated

Summary

Retrieve a list of production batches from OnPrintShop, with optional filtering by batch ID and search string, and support for pagination via limit and offset.

Inputs

  • Safe Mode — Boolean flag to block mutations in Complete API mode or reduce nested response fields in legacy actions (default: false).
  • Batch ID — Numeric filter to retrieve batches for a specific batch ID; set to 0 to disable this filter (default: 0).
  • Search — String to filter batches by search terms (default: none).
  • Limit — Maximum number of batch records to return in the response (default: 20).
  • Offset — Number of batch records to skip for pagination (default: 0).

Output shape

a list of batch metadata objects representing production batches, constrained by filters and pagination parameters

The response includes production batch metadata used by order and fulfillment workflows. The exact fields returned depend on the OnPrintShop API response format, with optional reduction of nested data when Safe Mode is enabled.

Links

Discussion