Shopfront Developers

Statements

Mutation

cloneStatement — Returns Statement

Scopes Required: modify_statements

Arguments Type Description

id

ID!

The ID of the Statement to clone

name

String!

The name of the newly cloned Statement
Example Mutation
mutation CloneStatement($id: ID!, $name: String!) {
    cloneStatement(id: $id, name: $name) {
        id,
        name,
        components,
        signature,
        replyTo
    }
}

# Example variables
{
    "id": "<ID>",
    "name": "<NAME>"
}

Mutation

createStatement — Returns Statement

Scopes Required: modify_statements

Arguments Type Description

name

String!

The name of the statement

empty

Boolean

Whether the new statement should contain the default template or be empty (defaults to true)
Example Mutation
mutation CreateStatement($name: String!) {
    createStatement(name: $name) {
        id,
        name,
        components,
        signature,
        replyTo
    }
}

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

Mutation

deleteStatement — Returns Statement

Scopes Required: modify_statements

Arguments Type Description

id

ID!

The ID of the statement to delete
Example Mutation
mutation DeleteStatement($id: ID!) {
    deleteStatement(id: $id) {
        id,
        name,
        components,
        signature,
        replyTo
    }
}

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

Mutation

updateStatement — Returns Statement

Scopes Required: modify_statements

This is currently an experimental mutation, please get in contact with us before using it.

Arguments Type Description

id

ID!

The ID of the statement to update

name

String!

The name of the statement

components

JSON

The components the statement is made up of

replyTo

String

The email address to reply to when this statement is emailed

signature

String

The HTML body of the email signature

subject

String

The default email subject to use when sending this statement template
Example Mutation
mutation UpdateStatement($id: ID!, $name: String!) {
    updateStatement(id: $id, name: $name) {
        id,
        name,
        components,
        signature,
        replyTo
    }
}

# Example variables
{
    "id": "<ID>",
    "name": "<NAME>"
}