Shopfront Developers

Documentation Applications Partner Program

Register Sign In

General

About General Information Authentication Headers GraphQL Getting Started Idempotent IDs Connections Scopes

How To

Authenticate Determine Product Prices eCommerce Payment Gateway Fulfilment Order Creation Direct Authentication Onboard to Shopfront Externally Ticket

Payments

Introduction

Reporting

Introduction Syntax

Embedded

Introduction Bridge Application Receivable Events Emitable Events Components Sale Fulfilment Authenticating

Webhooks

Introduction Verification Custom

Objects

Action Additional Field Additional Value Barcode Template Bulk Delete Products Buying Periods Classifications Closures Contact Customer Displays Customers Enterprise Form Favourites Gift Cards Host Integration Inventory Log Kitchen Mail Media Attachment Notification Orders Outlets Page Rule Payment Method Permission Price Lists Price Set Products Promotion Category Promotions Push Device Quick Menu Item Receipts Register Reports Restored Item Revision Role Sale Keys Sales Security Event Settings Shelf Tickets Statements Stocktake Suppliers Tax Rate Transferee Trashed Item User Utils Vendor Connections Vendor Webhook

Types

Cursor Date Time Date Email IPv4 IPv6 JSON Ordering Time Period Time URL

Enums

Action Enum Additional Field Type Enum Assign Tag Action Enum Business Type Enum Customer Display Slideshow Slide Type Enum Customer Payment Status Enum Day Of Week Enum Direction Enum Enterprise Source Enum External Stocktake Status Enum Favourite Form Page Type Enum Favourite Report Export Type Enum Favourite Report Orientation Enum Gift Card Movement Action Enum Gift Card Status Enum Has Price Item Type Enum Host Inventory Level Filter Enum Inventory Log Change Type Enum Inventory Reorder Rounding Type Enum Item Quantity Type Enum Kitchen Managed Role Id Enum Miscellaneous Movement Direction Enum Notifiable Type Enum Notification Action Type Enum Orders Page Rule Type Enum Payment Method Type Enum Payment Status Enum Price List Rule Enum Price Rule Enum Product Classification Type Enum Product Inventory Location Enum Product Name Case Enum Product Status Enum Product Type Enum Promotion Buy Amount Type Enum Promotion Item Type Enum Promotion Quantity Type Enum Promotion Type Enum Receipt Type Enum Recoverable Trash Type Enum Register Closure Table Print Type Enum Register Surcharge Item Type Enum Report Type Enum Sale Action Enum Sale Keys Template Enum Sale Status Enum Shelf Ticket Type Enum Special Report Type Enum Stocktake Event Enum Stocktake Scanned Enum Stocktake Source Enum Stocktake Status Enum Stocktake Type Enum Suppliers Surcharge Type Enum User Dark Mode Enum Vendor Connection Receive Type Enum Webhook Event Enum

Interfaces

Classification Search Interface Customer Display Component Settings Interface Favourite Report Interface Host Appliable Interface Inventory Log Event Interface Loyalty Interface Notifiable Interface Order Activity Content Interface Order Address Interface Printable Interface Printable Reason Interface Report Filter Interface Sale Action Affecting Interface Sellable Interface Settings Interface Surcharge Item Interface

Unions

Gift Card Creation Source Union Has Price Classification Union Product Classification Union

Inputs

Additional Field Input Additional Value Input Barcode Template Input Contact Input Customer Displays Customer Payment Input Favourite Report Email Settings Input Host Kitchen Movements Notifiable Input Orders Price Lists Product Input Product Supplier Code Input Products Promotions Quick Menu Item Input Receipts Register Closures Registers Reports Sales Stocktake Count Input Stocktake Update Input Supplier Authentication Input Suppliers Trashed Item Recovery Input Vendor Connection Code Input

Queries

Barcodes Buying Periods Classifications Closures Customer Displays Customer Groups Customers Enterprise Gift Cards Host Integrations Kitchen Mail Log Notifications Orders Outlets Page Rules Payment Methods Price Lists Price Sets Products Promotion Categories Promotions Push Receipts Registers Reports Roles Sale Keys Sales Security Shelf Tickets Statements Stocktakes Suppliers Tax Rates Transferees Trashed Items Users Vendor Connections Vendor Webhooks

Mutations

Actions Buying Periods Classifications Customer Displays Customer Groups Customers Gift Cards Host Integrations Kitchen Loyalties Miscellaneous Notifications Orders Outlets Page Rules Payment Methods Price Lists Price Sets Products Promotion Categories Promotions Push Quick Menu Receipts Registers Reports Roles Sale Keys Sales Security Settings Shelf Tickets Statements Stocktakes Suppliers Takings Tax Rates Transferees Trashed Items Users Vendor Connections Vendor Webhooks

IPv4

On this page

IPv4

Scalar

IPv4

The IPv4 scalar type represents an Internet Protocol version 4 address.

On this page

IPv4

© 2026 Shopfront. All rights reserved. View this page as Markdown