listWarehouseLocations

Topics: Logistics

List the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection. Requires warehouseLocation:list permission.

Returns

WarehouseLocationConnection!

Arguments

first

IntOptional

Maximum number of locations to return from the start of the page. Defaults to 20; values above the server's page-size limit (100) are rejected.

after

StringOptional

Opaque cursor from a previous page's endCursor: the page starts at the location immediately after it, in the requested sort order.

Narrows the locations returned; omit to list all of the tenant's locations.

Ordering rules to apply. Only the first rule is honoured, and both its field and direction are applied; omit to order by creation time, newest first.

Exact field SDL
"""
List the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection. Requires warehouseLocation:list permission.
"""
listWarehouseLocations(
  """
  Maximum number of locations to return from the start of the page. Defaults to 20; values above the server's page-size limit (100) are rejected.
  """
  first: Int
  """
  Opaque cursor from a previous page's endCursor: the page starts at the location immediately after it, in the requested sort order.
  """
  after: String
  """
  Narrows the locations returned; omit to list all of the tenant's locations.
  """
  filter: WarehouseLocationFilterInput
  """
  Ordering rules to apply. Only the first rule is honoured, and both its field and direction are applied; omit to order by creation time, newest first.
  """
  sort: [WarehouseLocationSortInput!]
): WarehouseLocationConnection! @topic(names: ["logistics"])

Declared on Query. Access is checked by the platform for each operation.