Skip to main content

addressesByCustomerId

Retrieve addresses associated with a specific customer account.

Returns all addresses linked to the specified customer including delivery, billing, and contact addresses. Used for customer management and order fulfillment.

Possible errors:

  • ADDRESS_RESPONSE_ERROR: Failed to retrieve customer addresses from the backend service
  • ADDRESS_UNKNOWN_ERROR: Unknown error occurred during address retrieval
  • FORBIDDEN: Insufficient permissions to access customer addresses

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

addressesByCustomerId(
  customerId: Float!
  type: AddressType
): [Address!]!

Arguments​

addressesByCustomerId.customerId ● Float! non-null scalar​

Unique identifier of the customer.

Must be a positive integer representing a valid customer ID in the system.

addressesByCustomerId.type ● AddressType enum​

Filter addresses by type.

When provided, returns only addresses of the specified type (e.g., shipping, billing). If omitted, returns all address types.

Type​

Address object​