โ† API reference
Query / commerce

getAddressBy

Fetch an address by external ID. Requires address:read permission.

Arguments

externalIdString

External system identifier (unique per tenant)

Returns AddressState

Scalar fields at a glance

timezoneString
customerIdCustomerID
contactIdContactID
supplierIdSupplierID
externalIdString
โ†— View the complete AddressState type

Explore in a view

Order Intake
View exact SDL
"""Fetch an address by external ID. Requires address:read permission."""
getAddressBy(
  """External system identifier (unique per tenant)"""
  externalId: String
): AddressState @topic(names: ["commerce"])

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