listTrees

query

Requires commerce.product:read.

List trees. Excludes the special categories list tree.

Required headers

Header	Required	Description
`x-store-id`	Yes	ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: `extensions.code: "UNAUTHENTICATED"`.

Go to Authentication for credential setup.

Arguments

after String optional
before String optional
createdAt CreatedAtFilter optional
- gt String optional
- lt String optional
first Int optional
id ListTreeIdsFilter optional
- in [String!] optional
last Int optional
name NameFilter optional
- contains String optional — Filters items where the name contains the specified string, case-insensitive.
- eq String optional
- in [String!] optional — Filters items where the name matches any of the specified names.
orderBy ListTreeOrderBy optional
- createdAt OrderByDirectionEnum optional
- id OrderByDirectionEnum optional
- name OrderByDirectionEnum optional
- updatedAt OrderByDirectionEnum optional
paginationType PaginationType optional Default: "CURSOR".
referenceValue ReferenceValueFilter optional
- eq String optional
- in [String!] optional
status ListTreeStatusFilter optional
- eq String optional
- in [String!] optional
updatedAt UpdatedAtFilter optional
- gt String optional
- lt String optional

Possible returns

QueryListTreesConnection QueryListTreesConnection

query GetListTrees($first: Int, $id: ListTreeIdsFilter) {  listTrees(first: $first, id: $id) {    edges {      node {        id        name        status        label        createdAt        updatedAt      }    }    pageInfo {      hasNextPage      endCursor      hasPreviousPage    }    totalCount  }}

{  "data": {    "listTrees": {      "edges": [        {          "node": {            "id": "ID_VALUE",            "name": "Example",            "status": "ACTIVE",            "label": "Example"          }        }      ],      "pageInfo": {        "hasNextPage": false,        "endCursor": null      },      "totalCount": 1    }  }}

Last updated on