Mutations / Transferees — Shopfront Developer Documentation

Mutation

createTransferee — Returns Transferee

Arguments	Type	Description
name	String!	The name of the transferee
orderAutomaticEmail	Boolean	Whether to automatically email the supplier when ordering stock
emailFormat	EmailFormatEnum	The email format to use when sending orders to the supplier
contact	ContactInput	The contact details for the transferee
sendOrdersToAccountsFlow	Boolean	Whether orders should send to Accounts Flow when sent, this can only be specified if the accounts flow integration is connected

Example Mutation

mutation CreateTransferee($name: String!) {
    createTransferee(name: $name) {
        id,
        name,
        parent,
        deleted,
        orderAutomaticEmail
    }
}

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

Mutation

deleteTransferee — Returns Transferee

Scopes Required: modify_transfer_list

Arguments	Type	Description
id	ID!	The ID of the transferee to delete

Example Mutation

mutation DeleteTransferee($id: ID!) {
    deleteTransferee(id: $id) {
        id,
        name,
        parent,
        deleted,
        orderAutomaticEmail
    }
}

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

Mutation

updateTransferee — Returns Transferee

Scopes Required: modify_transfer_list

Arguments	Type	Description
id	ID!	The ID of the transferee to update
name	String	The name of the transferee
orderAutomaticEmail	Boolean	Whether to automatically email the supplier when ordering stock
emailFormat	EmailFormatEnum	The email format to use when sending orders to the supplier
contact	ContactInput	The contact details for the transferee
sendOrdersToAccountsFlow	Boolean	Whether orders should send to Accounts Flow when sent, this can only be specified if the accounts flow integration is connected

Example Mutation

mutation UpdateTransferee($id: ID!) {
    updateTransferee(id: $id) {
        id,
        name,
        parent,
        deleted,
        orderAutomaticEmail
    }
}

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