Actions35
- Product Actions
- Get Category
- Get Detailed
- Get FAQs
- Get Many Categories
- Get Many Detailed
- Get Many FAQs
- Get Many Master Option Ranges (Legacy)
- Get Many Master Option Tags (Legacy)
- Get Many Master Options
- Get Many Option Groups (Legacy)
- Get Many Option Prices
- Get Many Options Rules
- Get Many Prices
- Get Many Simple
- Get Master Options
- Get Option Prices
- Get Options Rules
- Get Prices
- Get Simple
- Get SKU Matrix (Staging)
- Product Image Gallery Actions
- Complete API Actions
Complete API → Products Image Gallery
AI-generatedSummary
Retrieve image gallery data for products from the OnPrintShop Complete API, optionally filtering by product or gallery IDs and controlling pagination and returned fields.
Inputs
- Safe Mode — Boolean to block mutations in the Complete API; default is false.
- Corporate ID — Filter by corporate ID (integer).
- Limit — Limit the number of returned records (integer).
- Offset — Offset for pagination (integer).
- Products ID — Filter by specific product ID (integer).
- Products Image Gallery ID — Filter by specific products image gallery ID (integer).
- Input Mode — Choose between defining parameters as individual fields or as a JSON object.
- Arguments JSON — JSON object containing parameters when using JSON input mode.
- Return Fields Mode — Specify whether to return all available fields or a custom selection.
- Return Fields — When using custom return mode, select which specific fields to include in the response.
Output shape
A JSON object containing the requested products image gallery data, including metadata fields such as current count and total count, along with the detailed attributes of each image gallery entry as specified by the selected return fields.
Supports optional pagination via limit and offset. Safe Mode can block mutations but this operation only reads data. Input parameters can be supplied either as discrete fields or as a JSON object depending on Input Mode. Return data can include all fields or a tailored selection depending on Return Fields Mode and selection.
Examples
Example 1: Retrieve image galleries for a specific product limiting to 10 entries.
Set Products ID to target product, Limit to 10, Return Fields Mode to 'All Fields'.
Example 2: Fetch image gallery with a specific gallery ID, returning only selected fields.
Set Products Image Gallery ID, Return Fields Mode to 'Custom Selection', choose relevant fields like title and status.