OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Product Option Rules

AI-generated

Summary

Reads product option rules from the OnPrintShop Complete API, returning rule details and the API’s total rule count. This is a read-only query; Safe Mode blocks mutations and does not change this operation.

Inputs

  • Safe Mode — Defaults to false. Blocks Complete API mutations when enabled; it does not affect this read.
  • Input Mode — Choose Fields to supply optional parameters in the Parameters collection, or JSON Object to supply them as an Arguments JSON object.
  • Parameters — In Fields mode, optionally set Limit, Offset, and Rule ID to filter or paginate the rules.
  • Arguments JSON — In JSON Object mode, provide the API arguments, such as limit, offset, or rule_id.
  • Return Fields Mode — Choose All Fields or Custom Selection to control which fields are requested.
  • Return Fields — In Custom Selection mode, select fields such as rule ID, name, type, comparison value, status, sort order, and source or hidden option and attribute IDs.

Output shape

A list of items, each containing the selected product option rule fields and, when returned by the API selection, total count fields.

The query requests the productOptionRules collection with limit, offset, and rule_id arguments. The API response is returned with field aliases normalized; available output fields include currentCount and totalProductOptionRules. Errors from the GraphQL API are raised as node errors.

Links

Discussion