OnPrintShop Products icon

OnPrintShop Products

Read OnPrintShop product catalog, category, pricing, FAQ, and SKU matrix data

Complete API → Products Details

AI-generated

Summary

Retrieve detailed information about products using the OnPrintShop Complete API with optional parameters for filtering, pagination, and field selection.

Inputs

  • Safe Mode — Boolean to block mutations in the Complete API, ensuring no record changes occur during retrieval.
  • Parameters — Optional filters such as all_store, external_catalogue, limit, offset, products_id, and status to refine product details fetched (usable when Input Mode is 'Fields').
  • Arguments JSON — Raw JSON object specifying API parameters for product details (usable when Input Mode is 'JSON Object').
  • Input Mode (required) — Choose between providing parameters as individual fields ('Fields') or as a JSON object ('JSON Object').
  • Pagination — Control the retrieval of multiple pages of results: off, all records, or limit records with pagination settings.
  • Page Size — Maximum number of records to fetch per page when pagination is enabled.
  • Page Delay (Ms) — Delay in milliseconds between paginated requests to respect API rate limits.
  • Max Pages — Maximum number of pages to retrieve before aborting to prevent excessive requests.
  • Max Records — Maximum overall records to fetch when using limited pagination.
  • Return Fields Mode — Select whether to return all available product fields or a custom subset.
  • Return Fields — Specify which product fields to include in the response for custom field selection mode.

Output shape

a single API response object containing an array of product details with fields as specified by input parameters and pagination options.

Supports paginated fetching of product data with control over the number of pages and records. Field selection allows fetching either all fields or specific custom fields of product details. Safe Mode blocks any mutations ensuring read-only access.

Examples

Example 1: Fetch details for products with given products_id and status, returning only selected fields.

Set Input Mode to 'Fields'; provide products_id and status filter values; enable 'Return Fields Mode' to 'Custom Selection' and select desired product fields; optionally enable pagination to fetch all records.

Links

Discussion