Skip to content

Queuing Product Feed Runs

You can use the productfeedruns endpoint to initiate a product feed run and synchronize product data between your webshop and Hello Retail's system.

To use this endpoint, you'll need to know your website UUID and have an API key. To find these, log in to your account on https://my.helloretail.com/ and follow the guide provided here.

If your feed supports Hello Retail's delta token system, you have the option to queue it for a delta run or a full run. The type of run that will be queued next by our system determines which one will be chosen.

If your feed doesn't support the delta token system, all feeds will be queued for full runs.

If your feed supports the delta token system and you want to enforce a full run, you can do so by including the query parameter "full=true".

Endpoints

POST Queue specific feed

Request Method: POST

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

Parameters

Path
Name Type Description
websiteUuid String UUID of the website.
id String The ID of the product feed config.
Query
Name Type Description
apiKey String A valid API key. It can be created on your Hello Retail dashboard.

Example JavaScript request

fetch(`https://core.helloretail.com/api/websites/${websiteUuid}/productfeedruns/{$feedConfigId}?apiKey=${apiKey}`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
}).then((res) => {
    return res.json();
}).then((data) => {
    console.log(data)
});

Responses

200 OK        Productfeedruns Data 
{
    "data": {
        "id": "1",
        "type": "productfeedruns",
        "attributes": {
            "type": "V2_JSON_PAGED_BASED",
            "dateQueued": "Mon Apr 08 13:10:06 UTC 2024",
            "url": "https://demowebshop.com/product-feed",
            "runType": "FULL",
            "blockedUntil": "Mon Apr 08 13:15:06 UTC 2024"
        }
    }
}
POST Queue specific feed for Full run

Request Method: POST

Endpoint: https://core.helloretail.com/api/websites/{websiteUuid}/productfeedruns/{feedConfigId}?apiKey={apiKey}&full=true

Parameters

Path
Name Type Description
websiteUuid String UUID of the website.
id String The ID of the product feed config.
Query
Name Type Description
apiKey String A valid API key. It can be created on your Hello Retail dashboard.
full Boolean Set to true if you want to force full run

Example JavaScript request

fetch(`https://core.helloretail.com/api/websites/${websiteUuid}/productfeedruns/{$feedConfigId}?apiKey=${apiKey}&full=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
}).then((res) => {
    return res.json();
}).then((data) => {
    console.log(data)
});

Responses

200 OK        Productfeedruns Data 
{
    "data": {
        "id": "1",
        "type": "productfeedruns",
        "attributes": {
            "type": "V2_JSON_PAGED_BASED",
            "dateQueued": "Mon Apr 08 13:10:06 UTC 2024",
            "url": "https://demowebshop.com/product-feed",
            "runType": "FULL",
            "blockedUntil": "Mon Apr 08 13:15:06 UTC 2024"
        }
    }
}
POST Queue all feeds (See note)

Request Method: POST

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

NOTE: We strongly encourage you to queue specific feeds individually instead of queuing all at once.

Parameters

Path
Name Type Description
websiteUuid String UUID of the website.
Query
Name Type Description
apiKey String A valid API key. It can be created on your Hello Retail dashboard.

Example JavaScript request

fetch(`https://core.helloretail.com/api/websites/${websiteUuid}/productfeedruns?apiKey=${apiKey}`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
}).then((res) => {
    return res.json();
}).then((data) => {
    console.log(data)
});

Responses

200 OK        Productfeedruns Data 
{
    "data": [
        {
            "id": "1",
            "type": "productfeedruns",
            "attributes": {
                "type": "V2_JSON_PAGED_BASED",
                "dateQueued": "Mon Apr 08 13:10:06 UTC 2024",
                "url": "https://demowebshop.com/product-feed",
                "runType": "DELTA",
                "blockedUntil": "Mon Apr 08 13:15:06 UTC 2024"
            }
        },
        {
            "id": "2",
            "type": "productfeedruns",
            "attributes": {
                "type": "V2_JSON_PAGED_BASED",
                "dateQueued": "Mon Apr 08 13:10:06 UTC 2024",
                "url": "https://demowebshop.com/product-feed-supplementary",
                "runType": "FULL",
                "blockedUntil": "Mon Apr 08 13:15:06 UTC 2024"
            }
        }
    ]
}