public:webfronts_auto_import_api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| public:webfronts_auto_import_api [2021/02/05 12:50] – [Setting Up Your WebFronts Test Account (for POS Vendors)] jeff | public:webfronts_auto_import_api [2021/04/15 20:20] (current) – [Sending Data to WebFronts] jeff | ||
|---|---|---|---|
| Line 25: | Line 25: | ||
| * Master Account Name: SANDBOX_YOUR_POS | * Master Account Name: SANDBOX_YOUR_POS | ||
| * Master Account Password: ABCxyz123 | * Master Account Password: ABCxyz123 | ||
| + | |||
| + | Once you are set up as the " | ||
| ===== Sending Data to WebFronts ===== | ===== Sending Data to WebFronts ===== | ||
| + | ==== Swagger API / OpenAPI Specification ==== | ||
| + | https:// | ||
| + | |||
| + | ==== Using the WebFronts App URL Wizard ==== | ||
| WebFronts has a rich system for importing data from CSV files. For users, there is a " | WebFronts has a rich system for importing data from CSV files. For users, there is a " | ||
| * Which column in the CSV file contains the RWS model number (used to match rows)? | * 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 (used to distinguish | + | * Which column in the CSV file contains the RWS brand code? This is used to distinguish |
| * Which column(s) in the CSV file are being imported into which WebFronts column(s)? | * Which column(s) in the CSV file are being imported into which WebFronts column(s)? | ||
| - | * Should the data currently in the WebFronts column be completely erased before importing the data in the CSV file? | + | * 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), | For those who want to automate this process (i.e. POS integrators), | ||
| Line 42: | Line 48: | ||
| {{ : | {{ : | ||
| - | Clicking on that link will bring up a dialog with the "magic URL" as well as basic instructions for how to use it. 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 ('' | + | Clicking on that link will bring up a dialog with the "magic URL" as well as basic instructions for how to use it. |
| {{ : | {{ : | ||
| + | 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 ('' | ||
| - | ==== Important Notes ==== | + | ==== !! Important Notes !! ==== |
| - | You can upload multiple columns | + | When a user is making changes |
| - | Send data in bulk | + | |
| - | Once per hour max is best | + | |
| - | One request/ | + | 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. |
| - | ===== Download Columns (e.g. site or floor price) ===== | + | 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. |
| - | https://demo35859.appliances.dev.rwsgateway.com/ | + | |
| + | ===== 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: | ||
| + | |||
| + | ==== Pricing ==== | ||
| + | |||
| + | All APIs use the retailer' | ||
| + | |||
| + | Example Pricing API URL\\ | ||
| + | [[https://demo12345.appliances.dev.rwsgateway.com/ | ||
| You will get an XML file with all columns visible in WebFronts, including code, description, | You will get an XML file with all columns visible in WebFronts, including code, description, | ||
| - | 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 dump on you. If you have specific use cases, please bring them to me, and I' | + | < |
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | |||
| + | === 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: | ||
| + | |||
| + | 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 '' | ||
| + | Only Whirlpool Products\\ | ||
| + | [[https:// | ||
| - | ===== Pricing API ===== | + | Only Samsung Products\\ |
| + | [[https:// | ||
| - | https://demo35859.appliances.dev.rwsgateway.com/ | + | Only Ashley Products\\ |
| + | [[https://demo12345.appliances.dev.rwsgateway.com/ | ||
| - | That link will download everything - not necessarily what you want. To download all items for just one brand, you can add the URL param "MAN={CODE}" | + | Only Coaster Products\\ |
| + | [[https:// | ||
| - | Only Ashley Products | + | To download prices for a single model, use the URL parameter '' |
| - | https:// | + | |
| - | Only Coaster Products | + | [[https://demo12345.appliances.dev.rwsgateway.com/ |
| - | https://demo35859.appliances.dev.rwsgateway.com/ | + | |
| - | You can also download the prices | + | To search |
| - | With RWS Item Key | + | [[https://demo12345.appliances.dev.rwsgateway.com/ |
| - | https://demo35859.appliances.dev.rwsgateway.com/ | + | |
| - | Lookup by PN | + | //**Note:** This may return multiple models. They will be sorted by "best match" (same as a consumer search).// |
| - | https://demo35859.appliances.dev.rwsgateway.com/_CGI/pricing_only_specs.zip? | + | |
| - | Note: This may return multiple models. They will be sorted by "best match" | ||
| - | ===== Warning ===== | ||
| - | One request/ | ||
public/webfronts_auto_import_api.1612547442.txt.gz · Last modified: 2021/02/05 12:50 by jeff