Actions57
- Batch Actions
- Mutation Actions
- Order Actions
- Order Detail Actions
- Order Product Actions
- Order Shipment Actions
- Quote Actions
- Quote Product Actions
- Ship To Multiple Actions
- Status Actions
- Complete API Actions
- Get Batch
- Get Quote
- Order Billing Details
- Order Blind Details
- Order Delivery Details
- Order Products
- Order Shipment Details
- Order Status
- Order Summary
- Orders
- Quoteproduct
- Ship To Multiple Address
- Modify Order Product
- Set Batch
- Set Batch Job
- Set Order
- Set Order Product
- Set Order Product Image
- Set Order Product Image From URL
- Set Product Design
- Set Quote
- Set Shipment
- Update Order Status
Complete API → Set Batch
AI-generatedSummary
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
inputobject 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_idargument 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.