API docs by Redocly

Public offer information (2.0.0)

API for retrieving information about public offers on Allegro

Public offer information

Search offers

Access for verified applications only. 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. Changing the marketplace, country of delivery, currency or language may impact the availability of offers and filters. Note that requests for closed offers may be limited. This resource is rate limited to 270 requests per second.

Read more: PL / EN.

Authorizations:
NoneNone
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.

marketplaceId
string
Default: "allegro-pl"

Id of a marketplace where offers are visible. Acceptable values : allegro-pl, allegro-cz, allegro-sk, allegro-hu.

shipping.country
string
Example: shipping.country=PL

Expected language of messages.

currency
string <ISO 4217 currency code>
Example: currency=PLN

Currency of the offer prices. Default value : depends on marketplace, for allegro-pl: PLN, for allegro-cz: CZK, for allegro-sk: EUR. Check endpoint GET /marketplaces for acceptable currency values.

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

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

  • REGULAR - searching for a phrase in the title,
  • CLOSED - searching for a phrase in the title of closed offers. Available only for allegro-pl marketplace.
offset
integer [ 0 .. 599 ]
Default: 0

Index of the first returned offer from all search results. Max offset is 600 - <limit>.

limit
integer [ 1 .. 60 ]
Default: 60

The maximum number of offers in a response.

sort
string
Default: "relevance"
Enum: "relevance" "+price" "-price" "+withDeliveryPrice" "-withDeliveryPrice" "+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.
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".
header Parameters
Accept-Language
string <BCP-47 language code>
Enum: "en-US" "pl-PL" "uk-UA" "sk-SK" "cs-CZ" "hu-HU"
Example: pl-PL

Limits offers to the only translated to specified language. Also expected language of messages. Default value : depends on marketplace, for allegro-pl: pl-PL, for allegro-cz: cs-CZ, for allegro-sk: sk-SK. Check endpoint GET /marketplaces for acceptable language values.

Responses

Response samples

Content type
application/vnd.allegro.public.v1+json
{
  • "items": {
    },
  • "categories": {
    },
  • "filters": [
    ],
  • "searchMeta": {
    },
  • "sort": [
    ]
}