Poq-Documentation

Store Feed Integration

Overview

We require a file containing up-to-date store details, published at a location that is accessible to our feed processors.

Dependencies

To set this up on our end, we need to know from you:

  1. The URL of the feed file (see Hosting The Feed File) for the test and the production environments.

Updating Store Information

Poq uses the store feed file to update store details at regular intervals: you are therefore required to update it at regular intervals. We parse the store feed file every day.

Hosting The Feed File

You may host this file on an FTP/SFTP location protected by a username or password, or publicly hosted in a location accessible via standard HTTP protocol. Setting up dedicated connectivity (i.e. VPN) is not supported out of the box and would require custom scoping.

Alternatively, Poq can provide SFTP credentials that can be used to upload your feed file onto our datastore.

File Format

We support both CSV and XML file formats. Both file types are fully supported but we find CSV files easier to work with due to better tooling, smaller file size, and better human readability.

Formatting The Feed

Field List

Name Required Notes
id Yes Must be unique.
address Yes  
address2 No  
city Yes  
country Yes  
postCode Yes  
latitude Yes  
longitude Yes  
title Yes  
phone No  
isAvailableForInStoreCollection No true or false
mondayOpenTime No This is a text value.
tuesdayOpenTime No This is a text value.
wednesdayOpenTime No This is a text value.
thursdayOpenTime No This is a text value.
fridayOpenTime No This is a text value.
saturdayOpenTime No This is a text value.
sundayOpenTime No This is a text value.
mondayCloseTime No This is a text value.
tuesdayCloseTime No This is a text value.
wednesdayCloseTime No This is a text value.
thursdayCloseTime No This is a text value.
fridayCloseTime No This is a text value.
saturdayCloseTime No This is a text value.
sundayCloseTime No This is a text value.

CSV Files

We support comma separated values format as defined in RFC 4180 specification. The feed file must have a header line appearing as the first line of the file.

Sample CSV file template:

id,address,address2,city,country,postCode,latitude,longitude,title,phone,isAvailableForInStoreCollection,mondayOpenTime,tuesdayOpenTime,wednesdayOpenTime,thursdayOpenTime,fridayOpenTime,saturdayOpenTime,sundayOpenTime,mondayCloseTime,tuesdayCloseTime,wednesdayCloseTime,thursdayCloseTime,fridayCloseTime,saturdayCloseTime,sundayCloseTime
"store_1","Monmouth House","58 City Road","London","United Kingdom","EC1Y 2AL",0.0880964,51.5246789,"Poq Commerce Store","+44 (0) 203 794 4120",true,"08:00","08:00","08:00","08:00","08:00","08:00","08:00","20:00","20:00","20:00","20:00","20:00","20:00","20:00"

XML Files

XML files should always contain a <stores> root tag, with a <store> tag for each store.

Sample XML file template:

<?xml version=”1.0″ encoding=”utf-8″?>
<stores>
  <store>
    <id>store_1</id>
    <address>Monmouth House</address>
    <address2>58 City Road</address2>
    <city>London</city>
    <country>United Kingdom</country>
    <postCode>EC1Y 2AL</postCode>
    <latitude>0.0880964</latitude>
    <longitude>51.5246789</longitude>
    <title>Poq Commerce Store</title>
    <phone>+44 (0) 203 794 4120</phone>
    <isAvailableForInStoreCollection>true</isAvailableForInStoreCollection>
    <mondayOpenTime>08:00</mondayOpenTime>
    <tuesdayOpenTime>08:00</tuesdayOpenTime>
    <wednesdayOpenTime>08:00</wednesdayOpenTime>
    <thursdayOpenTime>08:00</thursdayOpenTime>
    <fridayOpenTime>08:00</fridayOpenTime>
    <saturdayOpenTime>08:00</saturdayOpenTime>
    <sundayOpenTime>08:00</sundayOpenTime>
    <mondayCloseTime>20:00</mondayCloseTime>
    <tuesdayCloseTime>20:00</tuesdayCloseTime>
    <wednesdayCloseTime>20:00</wednesdayCloseTime>
    <thursdayCloseTime>20:00</thursdayCloseTime>
    <fridayCloseTime>20:00</fridayCloseTime>
    <saturdayCloseTime>20:00</saturdayCloseTime>
    <sundayCloseTime>20:00</sundayCloseTime>
  </store>
</stores>