Shopfront Developers

Classifications

Query

brand — Returns Brand

Scopes Required: see_classifications

Arguments Type Description

id

ID!

The ID of the brand to get
Example Query
query GetBrand($id: ID!) {
    brand(id: $id) {
        id,
        name,
        parent,
        deleted,
        mdbId
    }
}

# Example variables
{
    "id": "<ID>"
}

Query

brands — Returns ConnectionType of Brand

Scopes Required: see_classifications

Sortable Fields

Fields from Brand that can be used to sort the connection items

  • name
Arguments Type Description

name

String

The name of the brand to search for
Example Query
query GetBrands($name: String) {
    brands(name: $name) {
        edges {
            node {
                id,
                name,
                parent,
                deleted,
                mdbId
            }
        },
        pageInfo {
            hasNextPage,
            endCursor
        }
    }
}

# Example variables
{
    "name": "<NAME>"
}

Query

categories — Returns ConnectionType of Category

Scopes Required: see_classifications

Sortable Fields

Fields from Category that can be used to sort the connection items

  • name
Arguments Type Description

name

String

The name of the category to search for
Example Query
query GetCategories($name: String) {
    categories(name: $name) {
        edges {
            node {
                id,
                name,
                parent,
                deleted,
                mdbId
            }
        },
        pageInfo {
            hasNextPage,
            endCursor
        }
    }
}

# Example variables
{
    "name": "<NAME>"
}

Query

category — Returns Category

Scopes Required: see_classifications

Arguments Type Description

id

ID!

The ID of the category to get
Example Query
query GetCategory($id: ID!) {
    category(id: $id) {
        id,
        name,
        parent,
        deleted,
        mdbId
    }
}

# Example variables
{
    "id": "<ID>"
}

Query

families — Returns ConnectionType of Family

Scopes Required: see_classifications

Sortable Fields

Fields from Family that can be used to sort the connection items

  • name
Arguments Type Description

name

String

The name of the family to search for
Example Query
query GetFamilies($name: String) {
    families(name: $name) {
        edges {
            node {
                id,
                name,
                parent,
                deleted,
                mdbId
            }
        },
        pageInfo {
            hasNextPage,
            endCursor
        }
    }
}

# Example variables
{
    "name": "<NAME>"
}

Query

family — Returns Family

Scopes Required: see_classifications

Arguments Type Description

id

ID!

The ID of the family to get
Example Query
query GetFamily($id: ID!) {
    family(id: $id) {
        id,
        name,
        parent,
        deleted,
        mdbId
    }
}

# Example variables
{
    "id": "<ID>"
}

Query

tag — Returns Tag

Scopes Required: see_classifications

Arguments Type Description

id

ID!

The ID of the tag to get
Example Query
query GetTag($id: ID!) {
    tag(id: $id) {
        id,
        name,
        parent,
        deleted,
        mdbId
    }
}

# Example variables
{
    "id": "<ID>"
}

Query

tags — Returns ConnectionType of Tag

Scopes Required: see_classifications

Sortable Fields

Fields from Tag that can be used to sort the connection items

  • name
Arguments Type Description

name

String

The name of the tag to search for
Example Query
query GetTags($name: String) {
    tags(name: $name) {
        edges {
            node {
                id,
                name,
                parent,
                deleted,
                mdbId
            }
        },
        pageInfo {
            hasNextPage,
            endCursor
        }
    }
}

# Example variables
{
    "name": "<NAME>"
}

Query

searchClassifications — Returns [ClassificationSearchInterface]

Scopes Required: see_classifications

Search through all classifications (brand, category, family and tag)

Arguments Type Description

search

String!

The name of the classifications to search for
Example Query
query SearchClassifications($search: String!) {
    searchClassifications(search: $search) {
        id
    }
}

# Example variables
{
    "search": "<SEARCH>"
}