Allegro REST API (latest)

https://developer.allegro.pl/about

Documentation is generated from this OpenAPI 3.0 specification file.

Authentication

bearer-token-for-user

For more information, see https://developer.allegro.pl/auth/#app to read about authorization code flow or https://developer.allegro.pl/auth/#DeviceFlow to read about the device code flow.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://allegro.pl/auth/oauth/authorize
Token URL: https://allegro.pl/auth/oauth/token
Scopes:
    x-deviceCode OAuth Flow
    Scopes:

      bearer-token-for-application

      Security Scheme Type OAuth2
      clientCredentials OAuth Flow
      Token URL: https://allegro.pl/auth/oauth/token
      Scopes:

        Public offer information

        Search offers

        Use this resource to get a list of offers based on the provided query parameters. At least one of: phrase, seller.id or category.id is required. Additional available parameters vary depending on category.id. The parameters are defined in the filters entity. Read more: PL / EN.

        query Parameters
        category.id
        string

        The identifier of the category, where you want to search for offers.

        phrase
        string

        The search phrase. The phrase is searched in different fields of the offers depending on the value of the searchMode parameter.

        seller.id
        string

        The identifier of a seller, to limit the results to offers from this seller. May be provided more than once. Should not be provided when seller.login is given.

        seller.login
        string

        The login of a seller, to limit the results to offers from this seller. May be provided more than once. Should not be provided when seller.id is given.

        searchMode
        string
        Default: "REGULAR"
        Enum: "REGULAR" "DESCRIPTIONS" "CLOSED"

        Defines where the given phrase should be searched in. Allowed values:

        • REGULAR - searching for a phrase in the title,
        • DESCRIPTIONS - searching for a phrase in the title and the descriptions,
        • CLOSED - searching for a phrase in the title of closed offers.
        offset
        integer [ 0 .. 119999 ]
        Default: 0

        Index of the first returned offer from all search results. Max offset is: - 120000 - <limit> if seller.id parameter is given in request, - 6000 - <limit> if no seller.id parameter is given in request.

        limit
        integer [ 1 .. 60 ]
        Default: 60

        The maximum number of offers in a response.

        sort
        string
        Default: "relevance"
        Enum: "relevance" "+price" "-price" "+withDeliveryPrice" "-withDeliveryPrice" "-popularity" "+endTime" "-startTime"

        Search results sorting order. + or no prefix in the value means ascending order. - prefix means descending order.

        include
        string

        Specify parts of the response that should be included in the output. Allowed values are the names of top level entities and all as an alias to all entities. By default, all top level entities are included. Use - prefix to exclude an entity. Example: include=-all&include=filters&include=sort - returns only filters and sort entities.

        fallback
        boolean
        Default: true

        Defines the behaviour of the search engine when no results with exact phrase match are found:

        • true - related (not exact) results are returned,
        • false - empty results are returned.
        Dynamic filters
        object

        You can filter and customize your search results to find exactly what you need by applying filters ids and their dictionary values to query according to the flowing pattern: id=value. When the filter definition looks like:

            {
                "id": "parameter.11323",
                "type": "MULTI",
                "name": "Stan",
                "values": [{
                        "value": "11323_1",
                        "name": "nowe",
                        "count": 21,
                        "selected": false
                    },
                    {
                        "value": "11323_2",
                        "name": "używane",
                        "count": 157,
                        "selected": false
                    },
                    {
                        "value": "11323_238066",
                        "name": "po zwrocie",
                        "count": 1,
                        "selected": false
                    }
                ]
            }

        You can use 'Stan' filter to query results, i.e.:

        • parameter.11323=11323_1 for "nowe"
        • parameter.11323=11323_2 for "używane"
        • parameter.11323=11323_238066 for "po zwrocie".

        Responses

        200

        The request successfully returns the search result.

        400

        Bad request. Check if all necessary parameters are provided.

        404

        Given category was not found. Check category.id parameter.

        422

        One of parameters have invalid value or given parameters combination is forbidden.

        500

        Internal service error.

        502

        Error caused by upstream service failure.

        get/offers/listing
        https://api.{environment}/offers/listing

        Response samples