OnPrintShop Customers icon

OnPrintShop Customers

Read, create, and update OnPrintShop customers and customer addresses

Customer → Get

AI-generated

Summary

Retrieves one OnPrintShop customer using the required email address and returns the selected customer and address fields. Choose custom, all, or no fields for each group; the default selections include common customer and address details.

Inputs

  • Email (required) — Email address of the customer to retrieve.
  • Customer Fields Mode — Choose Custom Selection, All Fields, or No Fields for customer fields. Custom Selection uses the checked fields; the default includes identifiers, name, email, telephone, status, and related account fields.
  • Customer Fields — Fields to return when Customer Fields Mode is Custom Selection. Options include name, email, status, company, balance, and other customer details.
  • Address Fields Mode — Choose Custom Selection, All Fields, or No Fields for address fields. The default custom selection includes name, street address, city, postcode, state, country, and telephone.
  • Address Fields — Address details to return when Address Fields Mode is Custom Selection. Leave empty or choose No Fields to exclude address details.
  • Safe Mode — Defaults to false. For legacy actions, Safe Mode reduces nested response fields; the property also describes blocking mutations in the Complete API, which is not relevant to this read operation.

Output shape

A single customer record

The node implementation is inherited from a shared domain node; the supplied source does not show the exact response envelope. Returned fields depend on the selected field modes and selections. Root GraphQL reads may require at least one field.

Examples

Example 1: Lookup an existing customer by their email and use the default customer and address selections.

Set Email to the customer's email address; leave both field modes at Custom Selection and retain their defaults.

Links

Discussion