OnPrintShop Customers icon

OnPrintShop Customers

Read, create, and update OnPrintShop customers and customer addresses

Complete API → Customers

AI-generated

Summary

Fetches customer records and their associated customer data from the OnPrintShop Complete API. Use the filters and pagination settings to control which records are returned, and choose which response fields to keep.

Inputs

  • Safe Mode — Blocks mutations in Complete API; this customer operation reads data.
  • Input Mode — Choose Fields to set parameters individually, or JSON Object to provide the API arguments as JSON.
  • Parameters — Optional API filters and paging arguments: Corporate ID, Date Type (login or registration), Department ID, Email, From Date, Limit, Offset, and To Date.
  • Arguments JSON — JSON object of API arguments; shown when JSON Object input mode is selected.
  • Pagination — Off preserves the API limit and offset. All Records fetches pages until complete; Limit Records stops after the configured maximum record count.
  • Page Size — Maximum records per request when pagination is enabled; replaces the API limit parameter.
  • Page Delay (Ms) — Delay between page requests when pagination is enabled.
  • Max Pages — Safety cap on page requests. Reaching it before completion fails rather than returning partial results.
  • Max Records — Record cap for Limit Records pagination.
  • Return Fields Mode — Return all fields or select specific response fields.
  • Return Fields — Fields to include in custom mode, such as customer details, address details, counts, or totals.

Output shape

A list of customer records with response data

The response can include customer and address details, current count, and total customer count. Custom return field selection can limit the fields; pagination settings control whether multiple pages are fetched.

Links

Discussion