OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Product → Get Options Rules

AI-generated

Summary

Retrieve OnPrintShop option rules for a specified rule ID and return the rule records with metadata. Choose which fields to request using the field selection mode or custom field list.

Inputs

  • Safe Mode — Optional boolean safety setting. The UI describes legacy behavior as reducing nested response fields; this operation requests a flat rule record.
  • Rule ID (required) — Rule ID to look up; the operation requires a non-empty value that parses as a number.
  • Options Rules Fields Mode — Select Custom Selection, All Fields, or No Fields. The source query uses a fixed set of rule fields, so this mode does not alter the fields requested by this operation.
  • Options Rules Fields — Custom field selection shown in the UI: action, condition, rule_id, rule_name, rule_type, and sort_order. The source query requests a fixed set of fields instead of reading this selection.

Output shape

A list of items, one per returned rule record.

Each item contains the fields requested by the implementation (rule_id, rule_name, rule_type, source_attribute_ids, hide_option_ids, hide_option_attribute_ids, status, sort_order, comparison_value, and disabled_for_admin), plus _operation, _ruleId, and _total metadata. The total reflects the API's totalProductOptionRules value. GraphQL or invalid-ID errors fail the item unless Continue On Fail is enabled.

Links

Discussion