OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Get Store

AI-generated

Summary

Fetches one or more stores from the OnPrintShop Complete API, supporting optional filters, pagination, and field selection to control the returned data.

Inputs

  • Corporate ID — Filter stores by corporate ID (integer).
  • Email — Filter stores by email address (string).
  • Status — Filter stores by status (integer).
  • Limit — Maximum number of stores to return (integer). Pagination uses successive queries to respect this limit.
  • Offset — Number of stores to skip before starting to return results (integer).
  • Safe Mode — Boolean flag to retry queries without nested groups if initial request fails with server error, helping with large queries.
  • Pagination — Controls whether to fetch all records, limit number of records with pagination, or disable pagination (off).
  • Page Size — Maximum records per request when pagination is enabled (integer between 1 to 1000).
  • Page Delay (Ms) — Delay in milliseconds between paginated requests to avoid rate limiting (integer between 0 to 60000).
  • Max Pages — Maximum number of pages to fetch in pagination to avoid excessive requests (integer).
  • Return Fields Mode — Select to return all fields or custom selected fields.
  • Return Fields — Specific store fields to return when using custom selection mode.

Output shape

a list of store objects, each possibly containing selected fields and nested department data, along with metadata such as totalStore and currentCount counts.

Supports pagination with safety limits. If pagination is off, the API limit and offset parameters control returned data. Safe Mode retries on 5xx errors reducing nested response complexity. Error responses include node operation errors with API error messages.

Examples

Example 1: Retrieve a list of stores with a specific corporate ID and active status

Set resource to "Complete API", operation to "Get Store", set Corporate ID filter to the desired ID, Status filter to 1 (active), adjust limit and offset as needed, optionally select Return Fields mode as "Custom Selection" to limit fields.

Links

Discussion