โ† API reference
Query / commerce

getCustomerBy

Fetch a customer by external ID. Requires customer:read permission.

Arguments

externalIdString

External system identifier

Returns CustomerState

Scalar fields at a glance

nameString!
externalIdString
emailString
phoneString
notesString
โ†— View the complete CustomerState type

Explore in a view

Order Intake
View exact SDL
"""Fetch a customer by external ID. Requires customer:read permission."""
getCustomerBy(
  """External system identifier"""
  externalId: String
): CustomerState @topic(names: ["commerce"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.