Shopfront Developers

Shelf Tickets

Query

browseAdminTicketTemplatePages — Returns [AdminTicketTemplatePage]

Scopes Required: see_shelf_tickets

Example Query
query BrowseAdminTicketTemplatePages {
    browseAdminTicketTemplatePages {
        id,
        name,
        folder,
        horizontalPanels,
        verticalPanels
    }
}

Query

browseAdminTicketTemplates — Returns [AdminTicketTemplate]

Scopes Required: see_shelf_tickets

Example Query
query BrowseAdminTicketTemplates {
    browseAdminTicketTemplates {
        id,
        name,
        folder,
        styles,
        transformationScript
    }
}

Query

shelfTickets — Returns ConnectionType of ShelfTicket

Scopes Required: see_shelf_tickets

Sortable Fields

Fields from ShelfTicket that can be used to sort the connection items

  • timestamp
  • name
Arguments Type Description

outlet

ID

Get a particular outlet's tickets
Example Query
query GetShelfTickets($outlet: ID) {
    shelfTickets(outlet: $outlet) {
        edges {
            node {
                id,
                createdAt
            }
        },
        pageInfo {
            hasNextPage,
            endCursor
        }
    }
}

# Example variables
{
    "outlet": "<OUTLET>"
}

Query

ticketQueue — Returns ConnectionType of Ticket

Scopes Required: see_shelf_tickets

Arguments Type Description

outlets

[ID!]

Obtain tickets for the provided outlets

users

[ID!]

Obtain tickets the provided users have added

types

[ShelfTicketTypeEnum!]

The printable types to filter by, if not provided this will return all "current" items (e.g. products, promotions)
Example Query
query GetTicketQueue($outlets: [ID!]) {
    ticketQueue(outlets: $outlets) {
        edges {
            node {
                id,
                queuedAt
            }
        },
        pageInfo {
            hasNextPage,
            endCursor
        }
    }
}

# Example variables
{
    "outlets": [
        "<OUTLETS>"
    ]
}

Query

ticketTemplate — Returns TicketTemplate

Scopes Required: see_shelf_tickets

Arguments Type Description

id

ID!

The ID of the ticket template
Example Query
query GetTicketTemplate($id: ID!) {
    ticketTemplate(id: $id) {
        id,
        name,
        styles,
        transformationScript,
        width
    }
}

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

Query

ticketTemplatePage — Returns TicketTemplatePage

Scopes Required: see_shelf_tickets

Arguments Type Description

id

ID!

The ID of the ticket layout
Example Query
query GetTicketTemplatePage($id: ID!) {
    ticketTemplatePage(id: $id) {
        id,
        name,
        horizontalPanels,
        verticalPanels,
        pageWidth
    }
}

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

Query

ticketTemplatePages — Returns [TicketTemplatePage]

Scopes Required: see_shelf_tickets

Example Query
query GetTicketTemplatePages {
    ticketTemplatePages {
        id,
        name,
        horizontalPanels,
        verticalPanels,
        pageWidth
    }
}

Query

ticketTemplates — Returns [TicketTemplate]

Scopes Required: see_shelf_tickets

Example Query
query GetTicketTemplates {
    ticketTemplates {
        id,
        name,
        styles,
        transformationScript,
        width
    }
}