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

Pricemaps Resource

This resource describes details of a single Pricemaps

"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.

Available Fields

NameDescriptionDatatypeResource"q"
idNumber
pidNumber
depidNumber
cidNumber
locidNumber
priorityNumber
enddtDateTime
startdtDateTime
unitpriceMoney/Currency
pricepctDouble
commentsString
dowDay of Week entry is valid onString
physkeyInternal unique identifierString
controlflagsControl any special effects when processing this pricemapNumber
promptString
publiccommentsString
barcodeA barcode that must be scanned before this pricemap will apply. See also the typecode field.String
typecodeA user entered voucher code or password that must be entered before this pricemap will apply. This is similar to the barcode field but manually enteredString
deltaprice
usertypekeyA physkey referencing the TypesUser table which describes a user defined group or categorisation for this pricemap entry. For example a key pointing to "Clearance Stock"String
marketingkeyA physkey referencing the MarketingProgram table which places this pricemap into a marketing effort.String
createdtDate/time (local) this record was createdDateTime
plevelminMinimum version of code to understand and process this recordNumber
pricegroupkeyPhyskey of a PriceGroup that defined or owns this entryString
rmsystemString
spidNumber
countrycodeValid for locations in this Country codeNumber
geoareaValid for locations in this Country codeNumber
pricetypeInternal code indicating what this pricemap holdsNumber
nocustomerpricebandBlock this pricemap and customer specific pricebands from existing on the same sale
repricesaleReprice the whole sale when this pricemap becomes valid for a sale