OnPrintShop Orders icon

OnPrintShop Orders

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

Complete API → Set Batch

AI-generated

Summary

Updates a batch in OnPrintShop through the Complete API using the required input object and optional batch_id. Safe Mode blocks mutations, so disable it to perform the write.

Inputs

  • Safe Mode — When enabled, blocks mutations in the Complete API.
  • Input Mode — Choose Fields to build the input object from the listed fields, or JSON Object to provide arguments as JSON.
  • Input (required) — The SetBatchMasterInput object. Fields mode exposes batch name, finishing and print instructions, filenames and image links for front and rear, jobs, nesting dimensions and size, print count, and send_mail. JSON scalar fields accept JSON objects, arrays, or expressions matching the API payload.
  • Batch ID — Optional integer batch_id argument in Fields mode.
  • Arguments JSON — Supply API arguments as JSON in JSON Object mode.
  • Partial Response — Choose to fail on errors or return partial data; partial results may include failures and should be reconciled before further writes.
  • Return Fields Mode — Return all fields or select a custom subset.
  • Return Fields — Custom response fields: batch_link, batch_pdf_link, id, message, and result.

Output shape

A single API response record.

All fields are returned by default; custom selection limits the response to selected fields. Partial-data mode may return results containing failures. Runtime details are delegated to imported modules not included in the source pack.

Links

Discussion