Queue Product Feed Runs Via API¶

Intro:

In this guide, you can learn how to use two different run types for product feeds.

The /productfeedruns endpoint triggers a rerun of the currently active product feeds configured in Hello Retail for any of your webshops.

Most webshops have a single product feed. In some edge cases, multiple feeds exist. Calling this endpoint queues a run for all active feeds on the specified webshop.

Two types of runs¶

Hello Retail supports two run types: a full feed run and a delta feed run.

A full feed run downloads and parses the complete product feed. The feed must represent your entire product catalog.

A delta feed run downloads and parses only the changes since the last run. The feed must represent the subset of your catalog that changed since the previous run.

Delta runs need to be supported by your system. Read more here.

Full feed runs are resource-intensive and are limited to a maximum of 1 run per hour.

Delta feeds can be run every 10 minutes. Combining delta feeds with the /productfeedruns endpoint provides fast product synchronization between your system and Hello Retail.

Below is the complete request URL for the /productfeedruns endpoint:

POST

 https://core.helloretail.com/api/websites/{websiteUuid}/productfeedruns?apiKey={apiKey}

Note

Add the query parameter full=true to force a full run. If omitted and your configuration supports delta runs, a delta run is queued.

Note

If a feed run is in progress or rate limits prevent an immediate run, the request is queued and executed as soon as rate limits allow.

To use the endpoint, you need your website UUID and an API key.

Log in to your business account on my.helloretail.com and follow these instructions to find them.

How does the response look?¶

Below is an example result from calling the /productfeedruns endpoint for a website with two active product feeds set up:

{
    "data": [{
        "id": "123",
        "type": "productfeedruns",
        "attributes": {
            "type": "Magento 1 - paginated",
            "url": "http://testshop.com/productfeed",
            "dateQueued": "Wed nov 15 09:10:02 UTC 2020",
            "blockedUntil": "Wed nov 15 09:10:02 UTC 2020",
            "runType": "DELTA"
        }
    },{
        "id": "456",
        "type": "productfeedruns",
        "attributes": {
            "type": "Json",
            "url": "http://testshop.com/extraproductfeed",
            "dateQueued": "Wed nov 15 05:11:02 UTC 2020",
            "blockedUntil": "Wed nov 15 05:34:02 UTC 2020",
            "runType": "FULL"
        }
    }]
}