inventoryLocations Query

Description

Retrieves a paginated list of inventory location names, with optional search filtering.

query inventoryLocations($offset: Int, $term: String, $limit: Int, $page: Int) {
  inventoryLocations(offset: $offset, term: $term, limit: $limit, page: $page) {
    entries
    pagination {
      limit
      count
      page
      pages
      hasMore
    }
  }
}

Variables

{
    "offset": 42,
    "term": "term",
    "limit": 20,
    "page": 1
}

Response

{
    "inventoryLocations": {
        "entries": [
            "example"
        ],
        "pagination": {
            "limit": 20,
            "count": 10,
            "page": 1,
            "pages": 1,
            "hasMore": true
        }
    }
}

Arguments

Name	Type	Description
offset	Int	Offset for pagination. This parameter is deprecated; use page instead.
term	String	Search term to filter locations by name.
limit	Int	Number of locations per page. You can request a specific page size, and it will be used if it does not exceed the server-enforced maximum. If your requested size exceeds the maximum, the server will enforce the maximum limit.
page	Int	The requested page number. Defaults to 1 if not specified.

Returns

InventoryLocations