OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Batch → Get Many

AI-generated

Summary

Retrieve multiple production batches with optional filtering by batch ID and search string, including pagination support and an optional safe mode to handle large queries.

Inputs

  • Safe Mode — Boolean flag to block mutations or reduce nested response fields for large queries that may fail otherwise.
  • Batch ID — Number to filter batches by a specific batch ID; 0 means no filtering by batch ID.
  • Search — String to filter batches using a search query.
  • Limit — Maximum number of batch records to return.
  • Offset — Number of batch records to skip for pagination.

Output shape

a list of batch objects each representing production batch metadata

Returns an array of batch detail objects including fields like id, batch_name, nesting_size, nest_width, nest_height, print_count, print_instructions, finishing_instructions, front_print_filename, front_cut_filename, front_image_link, rear_print_filename, rear_cut_filename, rear_image_link, jobs, and a metadata field _totalBatchDetails indicating the total number of batch details available. Supports pagination via limit and offset parameters. Errors result in operation-level exceptions or error objects if continue on fail is enabled.

Links

Discussion