Actions62
- Markup Master Actions
- Master Option Range Actions
- Master Option Tag Actions
- Mutation Actions
- Assign Options
- Set Additional Option (Beta)
- Set Additional Option Attributes (Beta)
- Set Markup Master (Legacy Alias)
- Set Master Option
- Set Master Option Attribute Price
- Set Master Option Attributes
- Set Master Option Rules (Legacy Alias)
- Set Master Option Tags
- Set Option Formulas
- Set Option Group
- Set Product
- Set Product Category
- Set Product Image Gallery
- Set Product Option Rules
- Set Product Pages
- Set Product Price
- Set Product Size
- Set Product SKU (Staging)
- Set Products Attribute Price (Beta)
- Set Quantity Based Attribute Price (Beta)
- Option Formula Actions
- Option Group Actions
- Product Actions
- Product Additional Option Actions
- Product Additional Attribute Price Actions
- Quantity Based Attribute Price Actions
- Complete API Actions
- Get Custom Formula
- Get Master Option Range
- Get Master Option Tag
- Get Option Group
- Set Additional Option
- Set Additional Option Attributes
- Set Assign Options
- Set Custom Formula
- Set Master Option
- Set Master Option Attribute Price
- Set Master Option Attributes
- Set Master Option Range
- Set Master Option Tag
- Set Option Group
- Set Product
- Set Product Category
- Set Product Option Rules
- Set Product Pages
- Set Product Price
- Set Product Size
- Set Product SKU
- Set Products Attribute Price
- Set Products Image Gallery
- Set Quantity Based Attribute Price
Mutation → Set Product Image Gallery
AI-generatedSummary
Set or update the product image gallery for a specified product by providing detailed image data either as a JSON array or as individual fields.
Inputs
- Safe Mode — Boolean flag to block mutations in Complete API or reduce nested response fields in legacy actions.
- Products ID (required) — The numeric ID of the product to update the image gallery for.
- Optimize Image — Numeric flag (0 or 1) indicating whether OnPrintShop should optimize images.
- Input Mode (required) — Choose input format for image data: as a JSON array or as individual fields.
- Input (JSON) (required) — A JSON object containing an array of image entries with properties like image IDs, titles, file names, status, order, and related attribute or option IDs. Required if Input Mode is JSON.
- Images (required) — A collection of image entries, each with multiple fields such as image gallery ID, image URL, large image name, and other optional metadata related to attributes, options, sorting, and status. Required if Input Mode is Fields.
Output shape
a single object containing the mutation result, typically reflecting updated product image gallery data or status.
The exact output shape depends on the OnPrintShop API response; safe mode may alter the response detail by blocking mutation or reducing nested fields. The operation requires the product ID and image details; image URLs must be accessible to OnPrintShop during processing.