Productfeed (ALPHA) - Heyloyalty/api GitHub Wiki

Productfeed

All endpoints can receive the unauthorized response:

Status: 401 Unauthorized

{
  "message": "Unauthorized",
  "code": 401
}

List productfeeds

Lists all productfeeds on your account

GET /integrations/productfeed

Parameters

Name Description Type Required
list_id Connected list string|integer

Notes

When parsing the list_id it will only return productfeeds that can be accessed by that list.

The list_id on a returned productfeed can be null, which just means it is able to be used across all lists on the account.

Response

Status: 200 OK

[
  {
    "id": 17,
    "list_id": null,
    "name": "Heyloyalty 1",
    "url": "http://heyloyalty.com/feed1",
    "setUpdate": 24,
    "latest_fetch": 7,
    "created_at": "2025-07-10T09:49:42.000000Z",
    "sync_blocked": 0
  },
  {
    "id": 19,
    "list_id": 26,
    "name": "Heyloyalty 2",
    "url": "http://heyloyalty.com/feed2",
    "setUpdate": 4,
    "latest_fetch": 1768,
    "created_at": "2025-07-10T09:49:42.000000Z",
    "sync_blocked": 1
  }
]

Errors

List not found

Status: 404 Not Found

{
  "message": "Not Found",
  "code": 404
}

Create a productfeed

Adds a new productfeed

POST /integrations/productfeed

Parameters

Name Description Type Required Allowed values
name productfeed name string x
url productfeed url string x
setUpdate productfeed update frequency string|integer x 4, 8, 12, 24
list_id connect productfeed to list string|integer

Notes

if no list_id is provided the productfeed will default to being accessible from all lists

Response

Returns the id of the newly created productfeed.

Status: 201 Created

{
    "id": "5"
}

Errors

Validation error

Is returned one error at a time

Status: 400 Bad Request

{
  "error": "{validation error message}"
}

List not found

Status: 404 Not Found

{
  "message": "Not Found",
  "code": 404
}

Edit a productfeed

Updates a productfeed

PUT /integrations/productfeed/{id}

Url Parameters

Field Description
id productfeed id

Parameters

Name Description Type Required Allowed values
name productfeed name string x
url productfeed url string x
setUpdate productfeed update frequency string|integer 4, 8, 12, 24
list_id connect productfeed to list string|integer

Response

Status: 204 No Content The method does not return anything on success.

Errors

Validation error

Is returned one error at a time

Status: 400 Bad Request

{
  "error": "{validation error message}"
}

ProductFeed or list not found

Status: 404 Not Found

{
  "message": "Not Found",
  "code": 404
}

Delete a productfeed

Deletes a productfeed.

DELETE /integrations/productfeed/{id}

Parameters

The method takes no parameters.

Response

Status: 204 No Content

The method does not return anything on success.

Errors

Productfeed not found

Status: 404 Not Found

{
  "message": "Not Found",
  "code": 404
}