Get Competition Data

Please note: Returns the entire Competition Data table. The table can grow very large when no mechanism is put in place to delete stale records, and if you employ multiple data providers, this will return all data, irrespective of the source.

Additionally to the regular /fetch command, this command supports (i.e. transparently handles) also global data as configured. This means that if, for example, the product competition data is configured to come from the global partition, this command will retrieve it from there. The regular fetch command will always only return data for the local partition.

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

Request Body schema: application/json

endRow	number Default: 300 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.
oldValues	any
operationType	string non-empty
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.
textMatchStyle	string non-empty

Responses

200

Response Schema: application/json

object

node

string non-empty

startRow

number

Array of objects non-empty unique

Array (non-empty)

version required	number
typedId required	string non-empty
sku required	string non-empty
competitorSku	any
competitor	any
label required	string non-empty
price required	number
priceType	any
priceUnit	any
unitOfMeasure	any
currency	any
competitionType	any
source	any
country	any
priority	any
comments	any
additionalInfo1	any
additionalInfo2	any
additionalInfo3	any
additionalInfo4	any
priceAPIRecord	any
integrationToken	any
createDate required	string non-empty
createdBy required	number
lastUpdateDate required	string non-empty
lastUpdateBy required	number
infoDate	any

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.

totalRows

number

status

number

Request samples

application/json

{"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact"
}

Response samples

application/json

{"response": {"node": "string",
"startRow": 0,
"data": [{"version": 0,
"typedId": "string",
"sku": "string",
"competitorSku": null,
"competitor": null,
"label": "string",
"price": 0,
"priceType": null,
"priceUnit": null,
"unitOfMeasure": null,
"currency": null,
"competitionType": null,
"source": null,
"country": null,
"priority": null,
"comments": null,
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"priceAPIRecord": null,
"integrationToken": null,
"createDate": "string",
"createdBy": 0,
"lastUpdateDate": "string",
"lastUpdateBy": 0,
"infoDate": null
}
],
"endRow": 0,
"totalRows": 0,
"status": 0
}
}