Mutations / Customer Displays — Shopfront Developer Documentation

Mutation

cloneCustomerDisplay — Returns CustomerDisplay

Scopes Required: modify_customer_displays

Arguments	Type	Description
id	ID!	The ID of the Customer Display to clone
name	String!	The name of the cloned Customer Display

Example Mutation

mutation CloneCustomerDisplay($id: ID!, $name: String!) {
    cloneCustomerDisplay(id: $id, name: $name) {
        id,
        name,
        mainColour,
        textColour
    }
}

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

Mutation

createCustomerDisplay — Returns CustomerDisplay

Scopes Required: modify_customer_displays

Create a new customer facing display

Arguments	Type	Description
name	String!	The name of the customer display
empty	Boolean	Whether the new customer display should contain the default template or be empty (defaults to true)

Example Mutation

mutation CreateCustomerDisplay($name: String!) {
    createCustomerDisplay(name: $name) {
        id,
        name,
        mainColour,
        textColour
    }
}

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

Mutation

deleteCustomerDisplay — Returns CustomerDisplay

Scopes Required: modify_customer_displays

Delete an existing customer facing display

Arguments	Type	Description
id	ID!	The ID of the customer display to delete

Example Mutation

mutation DeleteCustomerDisplay($id: ID!) {
    deleteCustomerDisplay(id: $id) {
        id,
        name,
        mainColour,
        textColour
    }
}

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

Mutation

updateCustomerDisplay — Returns CustomerDisplay

Scopes Required: modify_customer_displays

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

Arguments	Type	Description
id	ID!	The ID of the customer display
name	String!	The name of the customer display
idle	[CustomerDisplayComponentInput]	The display to show when there is no active sale
sale	[CustomerDisplayComponentInput]	The display to show when there is an active sale
mainColour	String	The main colour to use
textColour	String	The text colour to use

Example Mutation

mutation UpdateCustomerDisplay($id: ID!, $name: String!) {
    updateCustomerDisplay(id: $id, name: $name) {
        id,
        name,
        mainColour,
        textColour
    }
}

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