User's offer information

Get seller's offers

Use this resource to get the list of the seller's offers. You can use different query parameters to filter the list. Read more: <a href="../../tutorials/jak-zarzadzac-ofertami-7GzB2L37ase#jak-pobrac-moje-oferty-w-rest-api" target="_blank">PL</a> / <a href="../../tutorials/how-to-process-list-of-offers-m09BKA5v8H3#list-of-offers" target="_blank">EN</a>.

get/sale/offers

Request

  • Base URL: https://api.allegro.pl
  • URL: https://api.allegro.pl/sale/offers
  • Auth: OAuth 2 (authorization code, authorization URL https://allegro.pl/auth/oauth/authorize, token URL https://allegro.pl/auth/oauth/token, scopes: allegro:api:sale:offers:read)

Query parameters

offer.idstring[]

Offer ID.

[
  "16885969603"
]
namestring

The text to search in the offer title.

sellingMode.price.amount.gtenumber
Example:9.99

The lower threshold of price.

If additionally a publication.marketplace is provided, searches using the price on the given marketplace.

sellingMode.price.amount.ltenumber
Example:125.99

The upper threshold of price.

If additionally a publication.marketplace is provided, searches using the price on the given marketplace.

sellingMode.priceAutomation.rule.idstring

The ID of price automation rule. Returns offers with given price automation rule ID.

If additionally a publication.marketplace is provided, searches using the price automation rule on the given marketplace.

sellingMode.priceAutomation.rule.id.emptyboolean

Allows to filter offers by existence of price automation rule ID. Passing 'false' will return offers with any price automation rule, passing 'true' will return offers without any price automation rules.

If additionally a publication.marketplace is provided, searches using the price automation rule on the given marketplace.

publication.statusstring[]

The publication status of the offer. Passing more than one value will search for offers with any of the given statuses. By default all statuses are included. Example: publication.status=INACTIVE&publication.status=ACTIVE - returns offers with status INACTIVE or ACTIVE.

[
  "INACTIVE"
]
publication.marketplacestring

The id of a marketplace.<br/> Available marketplaces can be determined using <a href="#operation/marketplacesGET">GET /marketplaces</a>.

Example:allegro-pl

Either the base marketplace or an additional marketplace of the offer.

When passing the parameter publication.marketplace, searches for offers with the given marketplace as either its base marketplace or one of its additional marketplaces. When the parameter is omitted, searches for offers with all marketplaces.

In addition to searching, passing the parameter also influences the functionality of other query parameter by searching and sorting by data (e.g. price) on the given marketplace.

sellingMode.formatstring[]

The offer's selling format. Passing more than one value will search for offers with any of the given formats. By default all formats are included. Example: sellingMode.format=BUY_NOW&sellingMode.format=ADVERTISEMENT - returns offers with with format BUY_NOW or ADVERTISEMENT.

[
  "BUY_NOW"
]
external.idstring[]

The ID from the client's external system. Passing more than one value will search for offers with any of the given IDs. By default no ID is included. Example: external.id=1233&external.id=1234 - returns offers with ID 1233 or 1234. Single ID length shouldn't exceed 100 characters.

[
  "EXTERNAL_ID_122"
]
delivery.shippingRates.idstring uuid

The ID of shipping rates. Returns offers with given shipping rates ID.

delivery.shippingRates.id.emptyboolean

Allows to filter offers by existence of shipping rates ID.

sort'sellingMode.price.amount' | '-sellingMode.price.amount' | 'stock.sold' | '-stock.sold' | 'stock.available' | '-stock.available'

The results' sorting order. No prefix in the value means ascending order. - prefix means descending order. If you don't provide the sort parameter, the list is sorted by offer creation time, descending.

If additionally a publication.marketplace is provided, sorts by price and stock.sold using the data on the given marketplace.

limitinteger

The maximum number of offers returned in the response.

offsetinteger

Index of the first returned offer from all search results. Maximum sum of offset and limit is 10 000 000.

category.idstring

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

product.id.emptyboolean

Allows to filter offers by existence of product ID.

productizationRequiredboolean

Allows to search for offers from categories where productization is required.

b2b.buyableOnlyByBusinessboolean

Allows to search for offers buyable only by businesses.

fundraisingCampaign.idstring uuid

ID of the charity fundraising campaign that benefits from this offer.

fundraisingCampaign.id.emptyboolean

Allows to search for charity or commercial offers.

afterSalesServices.returnPolicy.idstring uuid

The ID of return policy. Returns offers with given return policy ID.

isFulfillmentboolean

Allows to search for offers handled by the Allegro Warehouse (One Fulfillment).

Headers

Accept-Language'en-US' | 'pl-PL' | 'uk-UA' | 'sk-SK' | 'cs-CZ' | 'hu-HU' BCP-47 language code

Expected language of messages.

Response

The list of offers returned successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.