Aukro WebAPI
doGetItemsList
This method is for getting a complete set of information on offers available within all listings (category, user and special) as well as on a list of search results. You can filter the data in numerous ways (e.g. by a listing type, keyword and search details, price, offer type or category parameters) and sort them by any of the available types. By default (i.e. without specifying category/department ID) a list of all main categories is returned (without any information on offers) and a list of fixed filters related to an offer listing (including the list of departments). The logic of the method is based on a system of filters returned contextually that allows for controlling the range of returned details. You can find a tutorial describing dynamic filters at: http://allegro.pl/webapi/tutorials.php/tutorial/id,321. This method returns data for the last two months (including ended auctions which have not been transferred to the archive yet).
-
webapiKey | String | required
User’s WebAPI key. -
countryId | Integer
ID of a country you wish to load the offers from (you can get a list of country IDs by using the doGetCountries method). -
filterOptions | FilterOptionsType[]
Criteria of filtering the results (a list of available in that certain context filters is returned as the output of the method within the filtersList structure).-
filterId | String | required
Filter ID. -
filterValueId | String[]
ID(s) of a filter’s value (single of multiple filters). -
filterValueRange | RangeValueType
The scope of a filter’s value (for range filters).-
rangeValueMin | String
Minimum filter value. -
rangeValueMax | String
Maximum filter value.
-
rangeValueMin | String
-
filterId | String | required
-
sortOptions | SortOptionsType
Option of offer sorting.-
sortType | String
Sort type: endingTime - remaining time/end time (default value for most of the listings), startingTime - time of listing, price - price, priceDelivery - price including shipping, popularity - popularity (number of placed bids), name - a title of an offer, relevance - relevance. -
sortOrder | String
Sorting order: asc - ascending (default value for most of the listings), desc - descending.
-
sortType | String
-
resultSize | Integer
Size of data portion (min. 1, max. 1,000). Default value: 100. -
resultOffset | Integer
Controlling the range of returned data (mask, values can be added): 1 - do not return the structure with filters, 2 - do not return a structure with categories, 4 - do not return a structure with offers). All data are returned by default. -
resultScope | Integer
Controlling the range of returned data (mask, values can be added): 1 - do not return the structure with filters, 2 - do not return a structure with categories, 4 - do not return a structure with offers). All data are returned by default.
-
itemsCount | Integer
Number of all offers (in a certain category and/or listed by a certain user and/or matching the query). -
itemsFeaturedCount | Integer
Number of promoted offers (included in the returned data package). -
itemsList | ItemsListType[]
Information on offers.-
itemId | Long
Offer ID. -
itemTitle | String | required
Offer title. -
leftCount | Integer
Number of available items. -
bidsCount | Integer
Number of items bought. -
biddersCount | Integer
Number of users buying/bidding within the offer. -
quantityType | String | required
Type of available items: pieces, sets or pairs. -
endingTime | OffsetDateTime
Scheduled end time of an offer. -
timeToEnd | String | required
Remaining time to end an offer (in words). -
categoryId | Integer
Category ID. -
conditionInfo | String | required
Item condition: new, used or undefined. -
promotionInfo | Integer
Promo options within the offer (mask, values can be added): 1 - Featuring, 2 - Highlighting, 4 - Boldface. -
additionalInfo | Integer
Additional marking within the offer (mask, values can be added): 1 - Allegro Standard (PL)/Aukro+ (CZ)/Super Offer (UA)/Vatera Premium (HU), 2 - free shipping. -
sellerInfo | UserInfoType
Information on a seller.-
userId | Integer
User ID. -
userLogin | String | required
Username. -
userRating | Integer
User’s score. -
userIcons | Integer
Additional information on a user (mask, values can be added): 1 - Junior account, 2 - “About me” page, 4 - Company account, 8 - Allegro shop, 16 - Super Seller (RU). -
countryId | Integer
ID of a country you wish to load the offers from (you can get a list of country IDs using the doGetCountries method).
-
userId | Integer
-
priceInfo | PriceInfoType[]
Information on item price.-
priceType | String | required
Price type: buyNow - Buy it Now!, bidding - current highest bid, withDelivery - price including shipping. -
priceValue | BigDecimal | required
Amount (presented in a currency of a country passed in countryId).
-
priceType | String | required
-
photosInfo | PhotoInfoType[]
Array of structures including information on uploaded offer photos.-
photoSize | String | required
Photo size: small - 64x48, medium - 128x96, large - 400x300. -
photoUrl | String | required
Photo URL. -
photoIsMain | Boolean
Information whether the photo is the main one (thumbnail on a listing): true/false.
-
photoSize | String | required
-
parametersInfo | ParameterInfoType[]
Information on parameters selected for an offer.-
parameterName | String | required
Parameter name (to be displayed by an application). -
parameterValue | String[]
Parameter value (single, list or from-to range). -
parameterUnit | String | required
Parameter unit (available only for a part of parameters). -
parameterIsRange | Boolean
Information whether a parameter is of range type: true/false.
-
parameterName | String | required
-
advertInfo | AdvertInfoType
Details of an ad (returned only in case of classifieds-type offers).-
serviceId | String | required
ID of a website from which an offer is taken: otoMotoPl, otoDomPl, otoWakacjePl, alleWakacjePl, oferiaPl, tablicaPl, strefaMarekAllegroPl, ebookiAllegroPl, otoMotoCz, hotelCz, bezRealitkyCz, spaCz, turistikCz, wikiRealityCz, iDeveloperCz, slandoUa and promUa. -
advertId | String | required
Ad ID.
-
serviceId | String | required
-
itemId | Long
-
categoriesList | CategoriesListType
Information on categories.-
categoriesTree | CategoryTreeType[]
“Sister” categories and “children” (first-tier) for category ID provided on the input or a list of main categories (if no particular category has been provided on input).-
categoryId | Integer
Category ID. -
categoryName | String | required
Category name. -
categoryParentId | Integer
supra-category ID. -
categoryItemsCount | Integer
Number of offers listed within the category.
-
categoryId | Integer
-
categoriesPath | CategoryPathType[]
Full category path leading to a category provided on input (not returned if a category has not been indocated).-
categoryId | Integer
Category ID. -
categoryName | String | required
Category name. -
categoryParentId | Integer
supra-category ID.
-
categoryId | Integer
-
categoriesTree | CategoryTreeType[]
-
filtersList | FiltersListType[]
Information on filters available in the given context.-
filterId | String | required
Filter ID. -
filterName | String | required
Filter name. -
filterType | String | required
Filter type: country - global filter for the given site/country, category - filter existing only within the passed category (parameter). -
filterControlType | String | required
Indicator type required to display a filter: combobox (a single value on a list), checkbox (multiple options on a list), textbox (values to be provide manually). -
filterDataType | String | required
Type of data accepted by a filter: string, int, long, float and datetime. -
filterIsRange | Boolean
Information whether a parameter is of range type: true/false. -
filterArraySize | Integer
Maximum number of values that can be passed for a certain filter (returned only for multiple filters). -
filterValues | FilterValueType[]
Information on the values of filters.-
filterValueId | String | required
ID of a filter’s value. -
filterValueName | String | required
Name of a filter’s value (to be displayed by an application). -
filterValueCount | Integer
Number of offers matching the given filter (returned if it is possible to count it in the given context).
-
filterValueId | String | required
-
filterRelations | FilterRelationType
Information on relations between the filters.-
relationAnd | String[]
List of all filter IDs the given filter must be used with. -
relationOr | String[]
List of filter IDs – at least one must be used with the given filter. -
relationExclude | String[]
List of filter IDs which the given filter cannot be used with.
-
relationAnd | String[]
-
filterId | String | required
-
filtersRejected | String[]
Filter IDs passed on the input, not activated by the given calling (due to mistakes or being incorrect in the given context).
-
ERR_FILTER_DEPENDENCY_ALL
Filter cannot be used without passing all provided filters: list of filters. -
ERR_FILTER_DEPENDENCY_AT_LEAST_ONE
Filter cannot be used without passing at least one of provided filters: list of filters. -
ERR_FILTER_DEPENDENCY_MISMATCH
Filter cannot be used with one of provided filters: list of filters. -
ERR_INPUT_COUNTRY_ERROR
Incorrect country identifier (indicated country is not included or null/empty value has been passed in a parameter). -
ERR_INCORRECT_FILTER_VALUE
Incorrect value of a filter value’s ID (for a single, multiply or range filter). -
ERR_INCORRECT_RESULT_SCOPE
Incorrect value of a range or returned data. -
ERR_INCORRECT_RESULT_SIZE
Incorrect value of a data portion size (exceeds the 1-1,000 range). -
ERR_INCORRECT_RESULT_OFFSET
Incorrect offset value (lower than 0). -
ERR_INCORRECT_SORT_ORDER
Incorrect value of a sorting order. -
ERR_INCORRECT_SORT_TYPE
Incorrect value of a sort type. -
ERR_WEBAPI_EXPIRED
Expiry date of WebAPI key has been exceeded (not applicable PL). -
ERR_WEBAPI_KEY_INACTIVE
WebAPI key used to generate the session has been deactivated (the key owner has not accepted WebAPI User Agreement). -
ERR_WEBAPI_NOT_AVAIL
Problems with Aukro WebAPI service.