Nationwide Docuwiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Automating Point of Sale Data on WebFronts Sites ======

===== Getting Stared with The WebFronts App =====
[[https://app.webfronts.com | The WebFronts App]] is the content management system that retailers use to manage their WebFronts website. Through the WebFronts App, retailers control pricing, which items to show, promotional content, and all other aspects of their sites. Retailers with a Level 3 or Level 4 WebFront also have full customization capabilities for the HTML and CSS of their sites. In many cases, a retailer's dedicated Account Manager will make changes on the retailer's behalf, especially for complex configurations.

In the WebFronts App, most configuration is done via the Edit Prices screen. Conceptually, the Edit Prices screen is modeled like a spreadsheet. Each row is a product, and each column is some value associated with each product, e.g. show on site, sale price. Retailers can set a single value that applies to every item ("fill the column") or set a unique value for each cell in the table.

WebFronts has a number of standard columns predefined, but users can also define "custom columns", which can contain any data the retailer enters. The retailer (or their Account Manager) can then add dynamic content to the site based on the values in those custom columns. For example, there might be a banner that shows on items with "Low Stock" or "Available at the Wichita location". This is how Point of Sale (POS) data - e.g. inventory or pricing - can be added to retailers' sites.

At a high level, the process looks like this:

  - Define one custom column for each unique value that will be imported into WebFronts
    * e.g. Inventory for Location A, Inventory for Location B
  - Configure the Auto Import URL(s) (see below) to upload data for all POS columns
  - Configure the retailer's POS system to upload data to WebFronts on a regular basis, e.g. daily or hourly
  - The retailer contacts their dedicated WebFronts Account Manager to use this data on their WebFronts site


==== Setting Up Your WebFronts Test Account (for POS Vendors) ====

  - Wait for an RWS employee (likely [[mailto:jeff.dezso@retailerwebservices.com | Jeff Dezso]]) to create a sandbox account
  - Go to https://app.webfronts.com
  - Create an account with your email address
  - Use the billable account name and password provided by RWS to link your user account with your billable account, e.g.
    * Master Account Name: SANDBOX_YOUR_POS
    * Master Account Password: ABCxyz123

Once you are set up as the "Owner" of the sandbox account, you can add other users to your account (no limit). You will also have full access to The WebFronts App for your account so you can test your integration.


===== Sending Data to WebFronts =====
==== Swagger API / OpenAPI Specification ====
https://demo31142.appliances.dev.rwsgateway.com/apis/webfronts/webfronts-import-api-v1.0.0.html#/

==== Using the WebFronts App URL Wizard ====

WebFronts has a rich system for importing data from CSV files. For users, there is a "wizard" in the WebFronts App (Tools > [[https://app.webfronts.com/data_import/upload_file.html | Import from Excel]]) that guides them through the decisions that need to be made:

  * Which column in the CSV file contains the RWS model number (used to match rows)?
  * Which column in the CSV file contains the RWS brand code? This is used to distinguish between identical model numbers in different brands. This selection is optional but highly recommended.
  * Which column(s) in the CSV file are being imported into which WebFronts column(s)?
  * Should the data currently in the WebFronts column(s) be completely erased before importing the data from the CSV file?

For those who want to automate this process (i.e. POS integrators), the wizard also generates a "magic URL" that can be used to send data programatically. This URL captures all the selections made in the wizard as well as a unique API key, which gives integrators permissions to upload files outside the WebFronts App.

The "magic URL" can be found on Step 4 of the wizard. At the bottom of the page, there is a link, ''Want to do this with a script?'':

{{ :public:do_this_with_a_script.jpg?nolink }}

Clicking on that link will bring up a dialog with the "magic URL" as well as basic instructions for how to use it. 

{{ :public:import_api.jpg?nolink }}

In short, integrators must send an HTTP POST to the "magic URL" with the CSV file to upload in the HTTP body as form data (''name=upload''). When a properly formatted and authorized request is received, the data in the attached CSV file is immediately imported into the WebFronts account and published to the site. Any errors will be noted in the JSON response.

==== !! Important Notes !! ====

When a user is making changes in the account, programmatic uploads will not post to the site immediately. Instead, they will be queued and published when the user publishes the rest of their changes.

A single CSV file can contain data for any number of WebFronts columns. Uploads are processed more quickly when a file contains multiple columns vs uploading each column in a separate CSV.

Programmatic uploads should be limited to one per store location per hour per account. Send all updates for the hour in a single file. If possible, update all columns in the same upload.


===== Getting Data from WebFronts =====

WebFronts has APIs that provide access to all the columns in The WebFronts App as well data on orders placed on WebFronts sites. If you are a POS vendor and are interested in getting access to these APIs, please contact [[mailto:jeff.dezso@retailerwebservices.com | Jeff Dezso]] for more information.

==== Pricing ====

All APIs use the retailer's domain plus a common URI as the endpoint. The ''PW'' URL argument acts as an API key, and can be provided by the retailer or an RWS employee.

Example Pricing API URL\\
[[https://demo12345.appliances.dev.rwsgateway.com/_CGI/pricing_only_specs.zip?PW=987654321]]

You will get an XML file with all columns visible in WebFronts, including code, description, formula, and computed value.

<code>
<product_pricing>
   <product>
      <key>CAFEA:UVH13012MSS</key>
      <brand_code>CAFEA</brand_code>
      <brand_name>CAFE</brand_name>
      <pn>UVH13012MSS</pn>
      <managed_data>
         <column_data>
            <REGULAR>=MSRP</REGULAR>
            <REGULAR_FPV>1200.0</REGULAR_FPV>
            <SALE>=MAP_WITH_PROMOS</SALE>
            <SALE_FPV>1199.0</SALE_FPV>
            <SPECIAL>N/A</SPECIAL>
            <ON_SITE>true</ON_SITE>
            <DELIVERY>Get Delivery Quote</DELIVERY>
            <FRT>N/A</FRT>
            <WARRANTY1>N/A</WARRANTY1>
            <WARRANTY2>N/A</WARRANTY2>
            <WARRANTY3>N/A</WARRANTY3>
            <WARRANTY4>N/A</WARRANTY4>
            <WARRANTY5>N/A</WARRANTY5>
            <WARRANTY9>N/A</WARRANTY9>
            <WARRANTY21>N/A</WARRANTY21>
            <WARRANTY33>N/A</WARRANTY33>
            <WARRANTY45>N/A</WARRANTY45>
            <WARRANTY57>N/A</WARRANTY57>
            <OFFER_WARRANTY>true</OFFER_WARRANTY>
            <OFFER_DELV>true</OFFER_DELV>
            <OUT_OF_CART_PRICE>N/A</OUT_OF_CART_PRICE>
            <IS_ITEM_PROTECTED>false</IS_ITEM_PROTECTED>
            <SORT_ORDER>N/A</SORT_ORDER>
            <BRAND_DISTANCE_RESTRICTION_CART>=BRAND_DISTANCE_RESTRICTION_GUIDELINE</BRAND_DISTANCE_RESTRICTION_CART>
            <BRAND_DISTANCE_RESTRICTION_QUOTE>=BRAND_DISTANCE_RESTRICTION_GUIDELINE</BRAND_DISTANCE_RESTRICTION_QUOTE>
            <STORE_DISTANCE_RESTRICTION_CART>=BRAND_DISTANCE_RESTRICTION_GUIDELINE</STORE_DISTANCE_RESTRICTION_CART>
            <STORE_DISTANCE_RESTRICTION_QUOTE>=BRAND_DISTANCE_RESTRICTION_GUIDELINE</STORE_DISTANCE_RESTRICTION_QUOTE>
            <ADVANCED_PRODUCT_FLAGGING_ON_DISPLAY>false</ADVANCED_PRODUCT_FLAGGING_ON_DISPLAY>
            <ADVANCED_PRODUCT_FLAGGING_CLEARANCE>false</ADVANCED_PRODUCT_FLAGGING_CLEARANCE>
            <ADVANCED_PRODUCT_FLAGGING_IN_STOCK>false</ADVANCED_PRODUCT_FLAGGING_IN_STOCK>
            <ADVANCED_PRODUCT_FLAGGING_GET_IT_TODAY>false</ADVANCED_PRODUCT_FLAGGING_GET_IT_TODAY>
            <ADVANCED_PRODUCT_FLAGGING_EXPRESS_DELIVERY>false</ADVANCED_PRODUCT_FLAGGING_EXPRESS_DELIVERY>
            <ADVANCED_PRODUCT_FLAGGING_BEST_SELLER>false</ADVANCED_PRODUCT_FLAGGING_BEST_SELLER>
            <ADVANCED_AVAILABILITY>=AA()</ADVANCED_AVAILABILITY>
            <ADVANCED_AVAILABILITY_FPV>0.0</ADVANCED_AVAILABILITY_FPV>
            <map>1199.0</map>
            <map_with_promos>1199.0</map_with_promos>
            <map_no_promos>1199.0</map_no_promos>
            <msrp>1200.0</msrp>
         </column_data>
      </managed_data>
   </product>
</product_pricing>
</code>


=== Querying the Pricing API ===

You can also query for only certain models from the WebFronts pricing API. Here's an overview of some of the search options. The full search API is too large to document here. If you have specific use cases, please bring them to [[mailto:jeff.dezso@retailerwebservices.com | Jeff Dezso]], and he will help you find the best approach.

By default, with no URL parameters, the pricing API will return prices for every item currently showing to consumers.

To download prices for just one brand, add the URL parameter ''MAN={CODE}''.

Only Whirlpool Products\\
[[https://demo12345.appliances.dev.rwsgateway.com/_CGI/pricing_only_specs.zip?PW=987654321&MAN=WHIRL]]

Only Samsung Products\\
[[https://demo12345.appliances.dev.rwsgateway.com/_CGI/pricing_only_specs.zip?PW=987654321&MAN=SAMSUNG]]

Only Ashley Products\\
[[https://demo12345.appliances.dev.rwsgateway.com/_CGI/pricing_only_specs.zip?PW=987654321&MAN=ASHLEY]]

Only Coaster Products\\
[[https://demo12345.appliances.dev.rwsgateway.com/_CGI/pricing_only_specs.zip?PW=987654321&MAN=COASTER]]

To download prices for a single model, use the URL parameter ''KEY={RWS_KEY}''.

[[https://demo12345.appliances.dev.rwsgateway.com/_CGI/pricing_only_specs.zip?PW=987654321&KEY=BRTWD:126237]]

To search for models by keyword or partial model number, use the URL parameter ''PN={text}''

[[https://demo12345.appliances.dev.rwsgateway.com/_CGI/pricing_only_specs.zip?PW=987654321&KEY=126237]]

//**Note:** This may return multiple models. They will be sorted by "best match" (same as a consumer search).//