CoCoCoCoCoCo / docs
← API reference
Query / commerce

listAddresses

List addresses with pagination. Requires address:list permission.

Arguments

firstInt

Number of items from the start

lastInt

Number of items from the end

afterString

Cursor to start after

beforeString

Cursor to start before

filterAddressFilterInput

Filter criteria

sort[AddressSortInput!]

Sort order

Returns AddressConnection!

Scalar fields at a glance

totalCountInt
↗ View the complete AddressConnection type

Explore in a view

Order Intake
View exact SDL
"""List addresses with pagination. Requires address:list permission."""
listAddresses(
  """Number of items from the start"""
  first: Int
  """Number of items from the end"""
  last: Int
  """Cursor to start after"""
  after: String
  """Cursor to start before"""
  before: String
  """Filter criteria"""
  filter: AddressFilterInput
  """Sort order"""
  sort: [AddressSortInput!]
): AddressConnection! @topic(names: ["commerce"])

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