OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Set Order Product Image

AI-generated

Summary

Updates image files for an OnPrintShop order product by calling the setOrderProductImage mutation. Provide the order product ID and the SetOrderProductImageInput payload; the mutation returns its result, message, and ID.

Inputs

  • Safe Mode — Defaults to false. The UI describes this as blocking Complete API mutations; the supplied source does not show how this setting is enforced for this operation.
  • Input Mode — Choose Fields or JSON Object. Fields mode exposes the imagefiles JSON scalar under Input; JSON Object mode accepts the mutation arguments through Arguments JSON.
  • Input (required) — Mutation input object. In Fields mode, imagefiles is an optional JSON scalar for the image data. The source calls setOrderProductImage with this input and an optional order product ID.
  • Parameters — Optional integer arguments: add_version_file_only, ask_for_approval, order_product_id, and update_ziflow_link_only. The UI shows these under Fields mode; source behavior for the Complete API operation is not included in the supplied excerpt.
  • Arguments JSON — JSON-mode arguments for the API operation. The supplied excerpt does not include the Complete API handler, so it does not establish the accepted argument structure.
  • Partial Response — Choose Fail on Errors (default) or Return Partial Data. The UI notes that partial results may contain failures and should be reconciled before further writes.
  • Return Fields Mode — Choose All Fields (default) or Custom Selection to control the returned fields.
  • Return Fields — In Custom Selection mode, select which of id, message, and result to return.

Output shape

A mutation result record containing the selected return fields; the declared fields are id, message, and result.

The operation writes to OnPrintShop. The input UI describes imagefiles as a JSON scalar; the legacy handler in the supplied source expects a SetOrderProductImageInput object and returns the mutation result. The source excerpt does not show the Complete API handler, so its exact payload construction and partial response behavior cannot be confirmed.

Examples

Example 1: Provide the order product ID and image payload

Use Fields mode, set order_product_id, and supply the documented image file data in imagefiles.

Links

Discussion