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
Product → Get Detailed
AI-generatedSummary
Reads one OnPrintShop product by its OPS product ID, returning selected product, size, and additional-option fields. Query filters and field-selection modes let you limit the result to the data your workflow needs.
Inputs
- Product ID (required) — OPS product ID to read.
- Query Parameters — Optional filters and pagination settings: all_store (default 0), externalCatalogue (default 0), limit (default 50), offset (default 0), and status (default 1 for active products).
- Product Fields Mode and Product Fields — Choose Custom Selection (default), All Fields, or No Fields for product-level fields. Custom Selection defaults to a broad set of catalog, description, SEO, pricing, and other product fields.
- Product Size Fields Mode and Product Size Fields — Choose Custom Selection (default), All Fields, or No Fields for nested size data. The default selection includes size ID, title, width, height, and sort order.
- Product Additional Options Fields Mode and Product Additional Options Fields — Choose Custom Selection (default), All Fields, or No Fields for nested additional-option data. The default selection includes option identifiers, titles, status, pricing-related fields, and attributes.
- Safe Mode — Defaults to false. The UI describes this as blocking mutations in the Complete API or reducing nested response fields in legacy actions; this operation is a read.
Output shape
A single product record
The record contains the selected product fields and, unless excluded by field selection, nested size and additional-option fields. The UI describes limit and offset as result pagination settings even though this operation reads one product by ID.