FD1 Client Protocol
 
Library Developer Home FD1 Client Protocol Home Concepts Reading Data Writing Data Protocol Defined Servers Connect & Authenticate Proxies & Tunnels
Webhooks & Firehoses Programming 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

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

NameDescriptionDatatypeResource"q"
physkeyUnique id identifying the rowString
physkeycustPhyskey of sale customerString
physkeysalePhyskey of saleString
saledtDateTime
rveDouble
physkeycontactContactId originally usedString
deliverdtRequested delivery dateDateTime
delivertimeString
deliverdurationTime in minutes that the DeliverTime value can be considered valid. The two fields work together to create a delivery window. 0 or blank means unlimitedNumber
addressPhysical delivery addressString
instructionsDelivery comments for courierString
phoneContact Phone. May be supplied to couriers to assist deliveryString
nameContact NameString
emailEmail address for delivery adviceString
collectlocationLocation id where shopper will click+collect fromNumber
firstnameString
lastnameString
address1String
address2String
address3String
address4String
address5String
address6String
postcodeString
stateState/Province of addressString
countryString
cityHolds city or town nameString
sitenameString
nz_nzpost
required_dateDateTime
collectdtDate/time local that the sale was collectedDateTime