Shopfront Developers

Sale Keys

Mutation

cloneSaleKeys — Returns SaleKeys

Scopes Required: modify_sale_keys

Arguments Type Description

id

ID!

The ID of the Sale Keys to clone

name

String!

The name of the cloned Sale Keys
Example Mutation
mutation CloneSaleKeys($id: ID!, $name: String!) {
    cloneSaleKeys(id: $id, name: $name) {
        id,
        name,
        saleKeys
    }
}

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

Mutation

createSaleKeys — Returns SaleKeys

Scopes Required: modify_sale_keys

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

Arguments Type Description

name

String!

The name of the sale keys folder

saleKeys

JSON

The keys to display ot the user

template

SaleKeysTemplateEnum

Sets the new sale keys to the default of the template
Example Mutation
mutation CreateSaleKeys($name: String!) {
    createSaleKeys(name: $name) {
        id,
        name,
        saleKeys
    }
}

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

Mutation

deleteSaleKeys — Returns boolean

Scopes Required: modify_sale_keys

Arguments Type Description

id

ID!

The ID of the sale keys to delete
Example Mutation
mutation DeleteSaleKeys($id: ID!) {
    deleteSaleKeys(id: $id)
}

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

Mutation

updateSaleKeys — Returns SaleKeys

Scopes Required: modify_sale_keys

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

Arguments Type Description

id

ID!

The ID scalar type represents a unique identifier.

The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. The ID is mathematically universally unique across all types and Vendors and can be used as such.

name

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

saleKeys

JSON

The JSON scalar type represents data that is stored in the JSON format as defined by ECMA-404.

We would highly suggest getting in contact with us before using any field that requests or returns JSON.
Example Mutation
mutation UpdateSaleKeys {
    updateSaleKeys {
        id,
        name,
        saleKeys
    }
}