Counterparty search parameters (EDistribexPriceQuery object)
Note
For the key: “Region or country of availability of goods” the search works only by full match (by the full name of the region or country), and for the keys: “Company name”, “Product category” the search works by both full and partial match.
JSON:
{
"producerName": "Сухаренко",
"categoryName": "Чай",
"regions": [
"Одеська",
"Полтавська"
]
}
Table 1 - Parameters description of object EDistribexPriceQuery
Parameter |
Format |
Description |
---|---|---|
Object EDistribexPriceQuery |
||
producerName |
String |
name of the Seller (Manufacturer) company |
producerIDs |
List<Long> |
array; identifier of the Seller (Manufacturer) company |
categoryName |
String |
product category |
categoryIDs |
List<Long> |
array; identifier of the product category |
regions |
List<String> |
array; region or country of availability of the goods |
regionsList |
List<EDistribexRegion> |
array of objects; data of countries / regions of Ukraine |
isPickup |
boolean |
presence of a “In-pickup!” mark |
limit |
object; selection filter (data output settings) |
Table 2 - Parameters description of object Limitation
Parameter |
Mandatory/Optional |
Format |
Description |
---|---|---|---|
Object Limitation |
|||
offset |
O |
int |
offset the first element of the list relative to the upper limit of the sample (by default 0) |
count |
O |
int |
sampling limit (amount) |
Table 3 - Parameters description of object EDistribexRegion
Parameter |
Format |
Description |
---|---|---|
Object EDistribexRegion |
||
id |
int |
record identifier |
countryId |
int |
country identifier |
countryRegionId |
int |
region identifier |
name |
String |
the name of the region or country |
nameEn |
String |
the name of the region or country in English |