OnPrintShopInstall

Summary

Fetch multiple customers from PrintShop API with pagination, field selection, and query filters.

Inputs

• safeMode — If enabled, retries first page without nested groups when server returns 5xx
• fetchAllPages — Automatically fetch all pages until no more records are available, ignoring limit/offset
• queryParameters — Query parameters to filter and paginate customer records, including email, date ranges, limit, offset, page size, and delay between pages
• customerFieldsGetAll — Select customer fields to return. All fields selected by default. Use 'Select All' or 'Deselect All' to modify.
• addressFieldsGetAll — Select address fields to return. All fields selected by default. Leave empty to exclude address details.

Output shape

Array of customer objects containing selected customer and address fields. Supports single-page retrieval or auto-paginated retrieval up to 100 pages with adaptive rate limiting and optional safe mode retry on 5xx errors.

Rate limiting is handled with adaptive delays (default 50ms, increasing to 1s on rate limit). Query parameters like limit, offset, pageSize, and pageDelay are ignored when fetchAllPages is enabled. Date filtering uses date_type (REGISTRATION or MODIFIED) with from_date and to_date.

Examples

Example 1: Retrieve all customers modified since a specific date, including address details.

Set fetchAllPages to true, date_type to MODIFIED, from_date to the desired timestamp, and ensure addressFieldsGetAll includes the needed fields.