Queue Product Feed Runs Via API

updated 1 yr ago

Intro:

In this guide, you can read and learn about how to use two different runs for product feeds.

The /productfeedruns endpoint can be used to trigger a rerun of the currently active product feeds that are set up in Hello Retail for any of your webshops.

For most webshops, there will only be one product feed but in some edge-cases, there can be multiple - all will be triggered for the given webshop by calling this endpoint.

Two types of runs

Hello Retail supports two types of runs; a full feed run and a delta feed run.

Full feed runs will download and parse a full version of your product feed, meaning the feed should represent your entire product catalog.

Delta feed runs will download and parse a delta of your product feed, meaning the feed should represent the part of your product catalog that has changed since the last feed run.

Delta runs needs to be supported by your system which you can read about here.

Full feed runs can be resource demanding and so there is a limit of maximum 1 run pr. hour.

Delta feeds can be run every 10 minutes which means a setup with delta feeds and the /productfeedruns endpoint can provide a very swift product synchronisation between your system and ours.

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

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

Note 1 You can add the request parameter full=true to force a full run even if your system supports delta runs.

Note 2 If a feed is currently being processed or the rate limiting doesn't allow for a new immediate run, your request will be added to a queue and executed as soon as the rate limiting permits it.

To use the endpoint you need to know your website Uuid and you need to have an API key.

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"
        }
    }]
}