Get a Product Set

post/productmanager.fetchproductsetcompetition/{label}

Retrieves products from the specified product set (configured for Competition Data API).

Information: You can retrieve the product set's label (that is required in the URL of this endpoint as a parameter) using the /fetch/PCOMPCO endpoint.

Required Permission Roles with the Required Permission
PRODUCTCOMPETITION_FETCH Data Integration (DATAINTEGRATION), View Competition Data (PB_COMPETITION_RO), Manage Products (PB_PRODUCTEDITOR), Administer Products (PB_PRODUCTS), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Manage Product Details Only (PB_PDETAILSEDITOR), Manage Products & Use EC (PB_PRODUCTEDITOR_EC), Manage Competition Data (PB_COMPETITION)
Securitybasic or X-PriceFx-jwt
Request
path Parameters
label
required
string

Enter the name of the product set you want to retrieve.

Request Body schema: application/json
startRow
number

The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

endRow
number

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

Responses
200

OK

Response Schema: application/json
required
object
node
string non-empty
csrfToken
string non-empty
startRow
number
Array of objects non-empty unique
Array (non-empty)
Array of objects non-empty unique
options
Array of objects
endRow
number
totalRows
number
status
number
Request samples
application/json
{
  • "startRow": 0,
  • "endRow": 10
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "csrfToken": "string",
    • "startRow": 0,
    • "data": [
      • {
        • "products": [
          ],
        • "options": [
          ]
        }
      ],
    • "endRow": 0,
    • "totalRows": 0,
    • "status": 0
    }
}