OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Get Store Locations

AI-generated

Summary

Fetches store location data from the OnPrintShop Complete API, supporting optional filters and pagination, and allows customization of which fields to return.

Inputs

  • Safe Mode — Optional toggle to block mutations and reduce nested response fields as needed for stability.
  • Limit — Maximum number of store locations to return.
  • Location ID Code — Filter results by location ID code.
  • Offset — Number of records to skip for pagination.
  • Status — Filter results by status.
  • Store Location ID — Filter by specific store location ID.
  • Return Fields Mode — Choose to return all fields or a custom selection of fields.
  • Return Fields — Select specific store location fields to include in the output when Return Fields Mode is set to custom.

Output shape

a list of store location records as JSON objects

Supports pagination via limit and offset inputs. Custom selection of returned fields is supported for optimized responses. Errors will be thrown if the API query fails.

Examples

Example 1: Get up to 10 active store locations with specific fields

Set Limit to 10, Status to active code (e.g., 1), Return Fields Mode to Custom, and pick desired fields like Store Location ID, Location Name, Store Address, and Store Phone.

Links

Discussion