Library
Developer Home
FD1 Client Protocol
Home
Concepts
Reading Data
Writing Data
Protocol Defined
Servers
Connect & Authenticate
Proxies & Tunnels
Webhooks & FirehosesProgramming Support
Logging
Minor Facts
State Facts
Response Format
How To Guides
eCommerce Sites
Custom Point of Sale
Customer Access
Bulk Downloads
Major APIs / Endpoints
All Endpoints
Products
Sales
SalesBuilder
Session
Get Attribute
Sale Capture
General Purpose
Data Capture
Devices
Barcode Scanners
Eftpos
IoT Sensors
Power Outlets
Printing
Scales
Security Cameras
Purchasing / Supply Side
Purchase Orders
Invoices
Invoice Payments
Document Capture
Rare APIs / Endpoints
SSL Certificates
API Key Management
Diagnositics
PosGreen
Server to Client Messages
Overview
Resources / Objects
Purchase Order
Invoice Payable
Invoice Payment
Product
Supplier
Location
Sale Lines
Sale Delivery Details
Sales
Price Maps
Employees
Carriers
Payments
Product Kits
Department 1
Customers
Webhooks & Firehoses
FD1 Endpoint Directory
Endpoint Name | Description |
fd1.fact.writefact | |
fd1.defer.get_defer | |
fd1.purchaseorders.get_purchaseorder_header | Retrive header type information about a purchase order(s) |
fd1.purchaseorders.edit_purchaseorder_header | Edit header information about a single purchase order |
fd1.purchaseorders.get_purchaseorder_detail | |
fd1.purchaseorders.get_invoice_payment | |
fd1.invoices.get_invoice | |
fd1.barcodes.decode_barcode | |
fd1.locations.get_locations_attribute | |
fd1.locations.get_locations_list | |
fd1.products.get_product_attribute | |
fd1.purchaseorders.add_invoice_payment | |
fd1.purchaseorders.email_purchaseorder | |
fd1.quickstats.get_quickstats_attribute | |
fd1.invoices.get_invoice_header | Retrive header type information about an invoice(s) received |
fd1.sales.sale_request | |
fd1.delf.data_entry_log_submit | |
fd1.supplier.edit_supplier_freight | |
fd1.supplier.edit_supplier_accounting | |
fd1.security.get_fd1_endpoints | Retrieve high level information of all (published) FD1 endpoints |
fd1.security.get_apikey | Get details about Api Key, list all API Keys |
fd1.security.edit_apikey_access | Alter the access rights for a single API key, or a security role |
fd1.allocate.randomid | Allocate and return a random physkey |
fd1.search.searchv1 | Perform context aware search. |
fd1.session.login | Send authorisation information to identify client user |
dbg1 Endpoint Directory
Packets sent to dbg1. are debug interface functions and are not for retailer use.