36
File Drop Samples
If the MYPOS Connect API is not an option then a secure login can be created that allows you to drop a file containing sales and / or customers.
- Specifically the CSV file might contain none, one or many customers.
- Specifically the CSV file might contain none, one or many sales receipts.
- A receipt might have a customer or it might be anonymous (a store walk in)
This allows you the opportunity to send a list of customers for import; or you can send a list of sales; or you can send a list of sales and the related customer details for those sales.
Access
The CSV file drop can only be from a recognised IP address that will need to be added to our systems. You will then be provided with a user code and password that allows you access to a test folder where you can leave files. An administration email must be setup before files can be sent that way if a file contains an error, for example a bad product or lengthy name, then the file can be returned as failed to the email address.
Valid orders will be acknowledged as processed to the email address.
As part of the setup of CSV we will give you access to an online form where you will fill in these details.
The CSV file itself
Reminder: If there are any errors in the CSV file it will be dropped, an email sent. The contents will not be imported for any record.
The format needs to be kept, the number of columns and what goes in each column means that both customers and receipts can be presented. If you do not have customers, keep the columns and format.
By definition a CSV file contains commas. You should ideally strip all commas from data you are sending via this method.
The CSV file can consist of one or more receipts and or one or more customers. A receipt can have no customer or a customer.
A customer that does not exist will be added. A customer that does exist will be updated.
|
Column |
Content required |
Example |
Notes |
|
ReceiptItemType |
required |
customer |
A row starts with a ReceiptItemType of customer. The contents of ReceiptItemType are always all lower case. |
|
ReceiptId |
required |
123456789012 |
The receipt number, normally numeric, can be alphanumeric, must be unique to this receipt across all markets. MYPOS can provide suitable number ranges or add a number prefix if required. |
|
TimeStamp |
required |
yyyy-MM-dd HH-mm-ss |
Local time of sale |
|
DeviceCode |
required |
1234 |
A valid device code, provided by MYPOS |
|
ProductCode |
leave empty |
|
|
|
ProductDescription |
leave empty |
|
|
|
SerialNumber |
leave empty |
|
|
|
BatchNumber |
leave empty |
|
|
|
Quantity |
leave empty |
|
|
|
ItemAmount |
leave empty |
|
|
|
CurrencyCode |
leave empty |
|
|
|
TaxCode |
leave empty |
|
|
|
TaxRate |
leave empty |
|
|
|
TaxAmount |
leave empty |
|
|
|
PromoCode |
leave empty |
|
|
|
PaymentBrand |
leave empty |
|
|
|
PaymentRef |
leave empty |
|
|
|
PaymentAuth |
leave empty |
|
|
|
CustId |
required |
CUST123 |
A unique a customer id or account number,max length 128 characters |
|
CustType |
optional or leave empty |
|
|
|
CustCompanyName |
If supplying CustFirstName plus CustLastName then this can be optional otherwise required |
ABC Corporation |
max length 50 characters |
|
CustTitle |
optional or leave empty |
Mr Mrs, Dr, Prof. Herr, Msr, Mdm |
max length 50 characters |
|
CustFirstName |
If supplying CustCompanyName then this can be optional otherwise required |
John |
max length 25 characters |
|
CustLastName |
If supplying CustCompanyName then this can be optional otherwise required |
Smith |
max length 25 characters |
|
CustAddress |
optional or leave empty |
123 Main Street |
max length 70 characters |
|
CustCity |
optional or leave empty |
Miami |
max length 50 characters |
|
CustRegion |
optional or leave empty |
FL |
max length 50 characters |
|
CustPostCode |
optional or leave empty |
33139-7212 |
max length 20 characters |
|
CustCountry |
optional or leave empty |
USA |
max length 50 characters |
|
CustEmail |
optional or leave empty |
max length 50 characters |
|
|
CustTelephone |
optional or leave empty |
+1 555 123 4567 |
max length 30 characters |
|
CustAllowDataShare |
optional or leave empty |
True |
True or False |
|
CustAllowMailing |
optional or leave empty |
False |
True or False |
|
CustRegistration |
optional or leave empty |
True |
True or False |
|
CustCompanyTaxNo |
optional or leave empty |
99887766 |
max length 50 characters |
|
CustIndividualTaxNo |
optional or leave empty |
GB123ABC |
max length 50 characters |
