Aukro WebAPI
doGetPostBuyFormsIds
This method return IDs of the after-sale forms (including surcharges) related to a user who is the session owner. You can filter the data numerous ways (e.g. by IDs of offers/users/payment options, strings in titles, payment status or time of creating the form). 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 the last month’s data sorted in descending order by the date of filling out the form.
-
sessionId | String | required
User's session identifier received using the doLogin(Enc) 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
-
resultSize | Integer
Size of data portion (min. 1, max. 1,000). Default value: 100. -
resultOffset | Integer
Controlling the process of getting another portion of data. Default value: 0.
-
formsCount | Integer
Number of found after-sale forms (including cancelled ones) and related surcharges. -
formsIds | Long[]
List of IDs of forms. -
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
-
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_INCORRECT_FILTER_ID
Provided filter ID does not exist (at all or in this certain context). -
ERR_INCORRECT_FILTER_VALUE
Incorrect value of a filter value’s ID (for a single, multiply or range filter). -
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_NO_SESSION / ERR_SESSION_EXPIRED
Invalid session identifier or the session has expired. -
ERR_TOO_MANY_FILTER_VALUES
Number of provided filters exceeds the limit (maximum 100). -
ERR_WEBAPI_KEY_INACTIVE
WebAPI key used to generate the session has been deactivated (the key owner has not accepted WebAPI User Agreement).