OnPrintShop Master Options icon

OnPrintShop Master Options

Manage OnPrintShop master options, attributes, formulas, rules, ranges, prices, tags, groups, and stock

Complete API → Get Master Option Stock Configs

AI-generated

Summary

Retrieve master option stock configurations from the OnPrintShop Complete API with optional filtering and pagination.

Inputs

  • Config ID — Optional integer to filter results to a specific stock configuration ID.
  • Limit — Optional maximum number of records to return.
  • Offset — Optional starting record offset for pagination.
  • Option Filter — Optional array of integer master option IDs to filter the stock configurations.
  • Return Fields Mode — Choose to return all available fields or a custom selection of fields from the stock configuration data.
  • Return Fields — When 'Custom Selection' is chosen, specify which fields from the stock configuration groups and configurations to return.

Output shape

a list of master option stock configuration groups, each with associated stock configuration details and metadata such as pagination counts.

Supports input parameters for filtering by config ID and master option IDs, and pagination via limit and offset. Optional custom selection of return fields allows clients to specify which parts of the stock configuration data to retrieve. The output includes fields such as group titles, stock types, option IDs, and individual configuration stock details.

Examples

Example 1: Get all master option stock configurations with default pagination

No config ID or option filters set, default limit and offset used. Returns all fields.

Example 2: Get specific stock configuration by config ID with limited fields

Set Config ID parameter and custom return fields mode selecting specific subfields within groups and configs.

Links

Discussion