NewsMAN API: feeds.getFeedProducts

Sections

KB Newsman

HomeAPIFeedsfeeds.getFeedProducts

Newsman Api Method: feeds.getFeedProducts

Prototype: feeds.getFeedProducts(list_id, feed_id, options, start, limit)

Description: Returns the products of a feed (max 5000 at once)

HTTP method: GET

Endpoint HTTP: /feeds.getFeedProducts.json

Endpoint XML-RPC: feeds.getFeedProducts

Return type: struct

Return info: Array with products of a feed (max 5000 at once)

Request parameters GET

Variable	Type	Description
list_id	int\|string	The ID of the list to which the feed belongs
feed_id	string	The Feed from which to return the products
options	struct\|array\|int\|string	Options array, the following keys are allowed: fetch_description (0 or 1). For no options send an empty array or null or empty string
start	int\|string	From where to start the pagination (0 for first product)
limit	int\|string	The number of products to return (max 5000 at once)

Response parameters

Parameter	Description
array	Array containing the products of a feed (max 5000 at once)

Output example

[
    {
        "product_id": "1000",
        "title": "The product title",
        "image": "image_url",
        "product_url": "product_url",
        "currency": "EUR",
        "category": "product category",
        "in_stock": true,
        "last_updated": "2023-09-27 10:02:27",
        "update_time": 1695798149,
        "website": "website.com",
        "nzm_feed_ids": [
            "feed_id_1",
            "feed_id_2"
        ],
        "discount": "-20%",
        "brandname": "product brand",
        "price": 55.31
    }
]

Response Errors

Code	Message	Description
407	No such list	Invalid list
407	Missing required param list_id	list_id param is required
407	Missing required param feed_id	feed_id param is required
407	Missing required param options	options param is required
407	Missing required param start	start param is required
407	Missing required param limit	limit param is required
1808	No such feed with ID: %s.	Feed not found
101	Not allowed for list_id = %s	Invalid access to list_id

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param feed_id",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param options",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param start",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param limit",
    "code": 407
}

{
    "err": true,
    "message": "Limit may not be greater than 5000",
    "code": 407
}