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
SaleDelivery Resource
This resource describes details of a single SaleDelivery
"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.
Available Fields
Name | Description | Datatype | Resource | "q" |
physkey | Unique id identifying the row | String | ||
physkeycust | Physkey of sale customer | String | ||
physkeysale | Physkey of sale | String | ||
saledt | DateTime | |||
rve | Double | |||
physkeycontact | ContactId originally used | String | ||
deliverdt | Requested delivery date | DateTime | ||
delivertime | String | |||
deliverduration | Time in minutes that the DeliverTime value can be considered valid. The two fields work together to create a delivery window. 0 or blank means unlimited | Number | ||
address | Physical delivery address | String | ||
instructions | Delivery comments for courier | String | ||
phone | Contact Phone. May be supplied to couriers to assist delivery | String | ||
name | Contact Name | String | ||
Email address for delivery advice | String | |||
collectlocation | Location id where shopper will click+collect from | Number | ||
firstname | String | |||
lastname | String | |||
address1 | String | |||
address2 | String | |||
address3 | String | |||
address4 | String | |||
address5 | String | |||
address6 | String | |||
postcode | String | |||
state | State/Province of address | String | ||
country | String | |||
city | Holds city or town name | String | ||
sitename | String | |||
nz_nzpost | ||||
required_date | DateTime | |||
collectdt | Date/time local that the sale was collected | DateTime |