OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Set Batch Job

AI-generated

Summary

Set batch jobs by creating or updating batches in OnPrintShop using specified batch ID and input details.

Inputs

  • Batch ID — Numeric ID of the batch to update; use 0 to create a new batch.
  • Input (JSON) (required) — JSON object containing the batch job details as per the SetBatchMasterInput schema.
  • Safe Mode — Boolean to block mutations in Complete API to ensure safety.
  • Partial Response — Option to fail on errors or return partial data when processing batch mutations.
  • Return Fields Mode — Choose to return all fields or custom selection of result fields.
  • Return Fields — Select specific fields to be returned such as 'message' or 'result' when using custom return mode.

Output shape

a list of objects representing the batch mutation result

Each object may include fields like result, message, id, batch_link, and batch_pdf_link. If the API returns errors, the execution fails unless continueOnFail is enabled.

Examples

Example 1: Create a new batch job

Set Batch ID to 0 and provide the batch job details in the input JSON.

Example 2: Update an existing batch job

Provide the existing Batch ID and update details in the input JSON.

Links

Discussion