Skip to main content

addressesByUserId

Retrieve addresses associated with a specific user account.

Returns all addresses linked to the specified user including shipping, billing, and other address types. Used for user profile management and order processing.

Possible errors:

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

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

addressesByUserId(
  userId: Float!
  type: AddressType
): [Address!]!

Arguments​

addressesByUserId.userId ● Float! non-null scalar​

Unique identifier of the user.

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

addressesByUserId.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​