Queries / Host — Shopfront Developer Documentation

Query

hostChanges — Returns HostChangesConnection

Arguments	Type	Description
connection	ID!	The connection to retrieve changes for
after	Cursor	Return the data after this cursor

Example Query

query GetHostChanges($connection: ID!) {
    hostChanges(connection: $connection) {
        __typename
    }
}

# Example variables
{
    "connection": "<CONNECTION>"
}

Query

hostConnection — Returns HostConnection

Scopes Required: see_host_connections

Arguments	Type	Description
id	ID!	The ID of the host connection to retrieve

Example Query

query GetHostConnection($id: ID!) {
    hostConnection(id: $id) {
        id,
        type,
        metadata,
        settings,
        credentials
    }
}

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

Query

hostConnections — Returns [HostConnection]

Scopes Required: see_host_connections

Example Query

query GetHostConnections {
    hostConnections {
        id,
        type,
        metadata,
        settings,
        credentials
    }
}

Query

hostHistory — Returns HostHistoryConnection

Scopes Required: see_host_changes

Arguments	Type	Description
connection	ID!	The connection to retrieve the recent history of
after	Cursor	Return the data after this cursor

Example Query

query GetHostHistory($connection: ID!) {
    hostHistory(connection: $connection) {
        __typename
    }
}

# Example variables
{
    "connection": "<CONNECTION>"
}

Query

hostMappedItems — Returns [HostMappingProduct]

Scopes Required: see_host_changes

Arguments	Type	Description
connection	ID!	The connection to retrieve changes for

Example Query

query GetHostMappedItems($connection: ID!) {
    hostMappedItems(connection: $connection) {
        __typename
    }
}

# Example variables
{
    "connection": "<CONNECTION>"
}

Query

hostRelatedItems — Returns [HostRelatedItem]

No scope required

Arguments	Type	Description
type	HostAppliableTypeEnum!	The type of item you want to retrieve the related items for
id	ID!	Shopfront's ID of the item you wish to retrieve the related items

Example Query

query GetHostRelatedItems($type: HostAppliableTypeEnum!, $id: ID!) {
    hostRelatedItems(type: $type, id: $id) {
        id,
        name
    }
}

# Example variables
{
    "type": "PRODUCT",
    "id": "<ID>"
}

Query

pendingHostIdentifiers — Returns HostIdentifierChangesConnection

Scopes Required: see_host_changes

Arguments	Type	Description
connection	ID!	The connection to retrieve the pending identifier changes for
after	Cursor	Return the data after this cursor
type	HostAppliableTypeEnum	The type of identifier changes to retrieve
filterMapped	FilterMappedEnum	Whether to filter out mapped identifiers

Example Query

query GetPendingHostIdentifiers($connection: ID!) {
    pendingHostIdentifiers(connection: $connection) {
        __typename
    }
}

# Example variables
{
    "connection": "<CONNECTION>"
}