NewsMAN API: feeds.getProductGroup

Sections

KB Newsman

HomeAPIFeedsfeeds.getProductGroup

Newsman Api Method: feeds.getProductGroup

Prototype: feeds.getProductGroup(list_id, product_group_id)

Description: Returns an array containing the data of a product group from the list

HTTP method: GET

Endpoint HTTP: /feeds.getProductGroup.json

Endpoint XML-RPC: feeds.getProductGroup

Return type: struct

Return info: Array with data of a product group

Request parameters GET

Variable	Type	Description
list_id	int\|string	The ID of the list to which the product group belongs
product_group_id	string

Response parameters

Parameter	Description
array	Array containing the data of a product group from the list

Output example

{
    "list_id": 456,
    "name": "api group top sold 2",
    "sortby": "top_sell_value",
    "feeds": [
        "the_feed_id"
    ],
    "filters": {
        "name": "name_filter",
        "url": "url_filter",
        "price_start": 5,
        "price_stop": 85,
        "category": [
            "category_1",
            "category_2"
        ]
    },
    "status": 1,
    "parse_status": 1,
    "filters_ecommerce": {
        "no_purchases_start": 2,
        "no_purchases_stop": 100,
        "purchased_qty_start": 5,
        "purchased_qty_stop": 50,
        "purchased_value_start": 10,
        "purchased_value_stop": 750,
        "interval_date": "last_6_months"
    },
    "count_products": 7,
    "id": "651fe01dc469884c76ec1c37"
}

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
407	Missing required param product_group_id	product_group_id param is required
1823	No such product group with ID: %s.	Invalid access to product group

Error examples

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

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

{
    "err": true,
    "message": "No such product group with ID: %s",
    "code": 1823
}