Access token

An access token is valid for 12 hours and enables to perform operations on the public API resources. Access tokens comply with the JWT standard.

Even though the tokens are valid for 12 hours, you do not need to oblige the user to reauthorize the application during this time - all you need to do is implement a refresh tokens feature in your application.

You can find more information in our guide.

Campaigns

You can distinguish offer on the list of offers by assigning it to a campaign. That way, it will receive a special badge, for example - if you submit an offer to Deal Zone, your offer will be marked with the Deal badge displayed on the list of offers along with a crossed out price. Another example of a badge is “HIT”, “New”, “Sale”, as well as seasonal labels such as “Black Week” or “Winter Sale”.

You can find more information in our guide and on the for sellers page:

Client ID

Application identifier which you will receive with Client Secret after registering it at https://apps.developer.allegro.pl/. Client ID is necessary to generate access token. The Client ID uniquely identifies the application. Each request from a given application should present the Client ID assigned to it.

You can find more information in our guide.

Client Secret

Application password which you will receive with Client ID after registering it at https://apps.developer.allegro.pl/. Client ID is always applied with Client ID in the authorization process. Do not share it with bystanders.

You can find more information in our guide.

Disputes

It is a feature owing to which buyers can clarify any transactional mishaps with a seller ― for example, when the package has not reached them, the item is damaged, or it differs from the one ordered.

You can find more information in our guide and on the for sellers page.

Events journals

Resources in which we return events in real time informing about recent changes, e.g. in the offer. We currently provide three types of events journals:

  • GET /order/events - which applies to orders. Using it, you can monitor customer actions such as:
    • purchase,
    • filling in shipping form,
    • payment cancellation,
    • making a surcharge,
    • order cancellation,
    • fulfillment status. You can find more information in our guide.
  • GET /sale/offer-events - which applies to offers of the authorized user. In the response we return changes that occurred within the last 24 hours about:
    • publishing offer,
    • change in the offer,
    • stock change in the offer,
    • price change in the offer,
    • ending offer,
    • archiving offer,
    • placing a bid in the offer,
    • canceling a bid in the offer.
  • GET /sale/category-events - which applies to categories. Using it you can check changes in categories that took place in the last 3 months. At present we support the four types of events:
    • new category was created,
    • category name has been changed,
    • category has been moved to a different place in the category tree,
    • category has been deleted.

Linked Apps

Tab, in which users can find external applications associated with their account. They can remove the association here - that way they will withdraw consent for the app to perform actions on their behalf.

Message center

The Message Center is the place where the buyers and the sellers communicate each other. It is a combination of chat and e-mail, in which you will find correspondence conducted within Allegro, as well as messages from buyers.

You can find more information in our guide and on the help center page.

Multi-variant offer

A multi-variant offer is a set of linked offers with different variants of the same product. Usually, variants of the same products differ by color, size, or weight, for example - the same model of shoes but in different sizes. You can create multi-variant offers manually and in selected categories we do it automatically.

You can find more information in our guide and on the for sellers page.

Offer

The offer contains information about the item that the seller is selling, but also includes individual information depending on the seller, such as:

  • price,
  • stock level,
  • selling format (i.e. Buy Now),
  • returns policy and complaints terms,
  • duration,
  • handling time,
  • invoice options,
  • shipping price list.

This is what differs the offer from the product. While a product has its own set of attributes that distinguish it from another product, an offer includes additional information that affects the final purchase decision of the buyer. Thus, many offers listed by different sellers can be associated with the same product, e.g. a specific phone model.

You can create an offer using POST /sale/offers or POST /sale/product-offers. We return the offer data up to 60 days after the end of publication - after this time we will transfer it to the archive.

You can promote the offer and assign it to the campaign.

More information can be found in our guides:

Order status

The status of the order depends on customer actions. We return the following statuses:

  • BOUGHT - the customer has purchased an item, but has not paid for the order yet;
  • FILLED_IN - the customer has filled the shipping form, but has not paid for the order yet;
  • READY_FOR_PROCESSING - the customer has filled the shipping form and finish payment;
  • CANCELLED - the order was cancelled.

You can find more information in our guide.

Order fulfillment status

Unlike the order status, which is assigned automatically based on the buyer’s actions, the order fulfillment status is assigned by the seller. With this, it can determine the stage at which the order is currently being processed.

Available order fulfillment statuses are:

  • NEW,
  • PROCESSING,
  • READY_FOR_SHIPMENT,
  • READY_FOR_PICKUP,
  • SENT,
  • PICKED_UP,
  • CANCELLED.

You can find more information in our guide.

Product

The item which you list for sale in the offer. It has individual attributes that uniquely identify it, such as parameters or an EAN number. Multiple offers from different sellers can be assigned to the same product.

Currently, part of your offers must be associated with the Allegro Product Catalog. At the end of Q2 2022, we plan to increase the percentage requirement - we want 100% of newly listed offers to be associated with the Product Catalog.

You can - How to list an offer assigned to a product with one request, - Assigning offers to products.

Product Catalog

It is a database of products that sellers should associate their offers with. Buyers on Allegro can browse millions of offers listed by you or other sellers. The offers themselves may differ in price or in the terms of sale, but the actual product sold stays the same.

As part of this Product Catalog, we aim to collect and comprehensively describe all products available for purchase on Allegro by sellers. We catalog products based on the unique properties that set them apart from others, like a specific model, manufacturer’s code, GTIN number, or other basic parameters.

You can search for products from our catalog using GET /sale/products. More information can be found in our guide and for sellers page.

Promo options

You can promote each offer, which it will attract more buyers to it. We provide the following promo options:

  • Flexible Emphasized - for which we charge a fee every day,
  • Emphasized - for which we charge a fee every ten days,
  • Promo package - (Emphasized + Highlight + Bold) - for which we charge a fee every day,
  • Department page promo - additional option, for which we charge a fee every ten days.

You can find more information in our guide and on the for sellers page.

Refresh token

A token which extends user authorization validity for application. You receive it in pairs with an access token, which is valid for 12 hours. In order to ensure that a user is not obliged to perform application authorization twice a day, you can use refresh tokens.

You can find more information in our guide.

Sale commission refunds

You can apply for a sale commission refund, when you sold an item, but the transaction did not take place.

You can find more information in our guide and on the for sellers page.

Sandbox

Allegro Sandbox is an Allegro test environment. Use it to test, in a secure manner, REST API supported by Allegro. The environment reflects all the major features of Allegro. It means you can:

  • activate an account,
  • list an offer,
  • go through a customer journey,
  • use a search engine,
  • rate a seller.

With a built-in simulator you can also test quick online payments.

You can find more information in our guide.

Scope

Scopes define the level of authorization to use the Allegro API. Each scope is assigned a set of permissions that define:

  • a set of resources that can be accessed using scope,
  • a set of operations that can be performed in scope.

You define the scopes at the user authorization stage. Below you can see a sample request that allows the application to access only resources for managing offers and reading orders:

../auth/oauth/authorize?response_type=code&redirect_uri=www.example.com&client_id=438f71d3a26e4d829783a0a621873465& scope=allegro:api:sale:offers:write%20allegro:api:orders:read


The consent screen that the user sees in this case will look like this:

consent_scope_short

You can find a full list of scopes in our guide.

Ship with Allegro

Ship with Allegro is a tool that facilitates parcel management on Allegro. Sellers can prepare parcels and print labels there and order a pickup of parcels from the indicated address by carriers.

You can find more information in our guide and on the for sellers page.

Shipping price lists

Shipping price lists make managing prices of your items easier. With shipping price lists there is no need to complete the prices each time you list an offer. You only need to create a price list and add it to your offers.

Shipping price lists make it easier to manage your shipping options as well. You can create various templates, e.g. depending on the type of items you list. You can save up to 250 various price lists, each with a different name to make picking the correct one easier.

You can find more information in our guide and on the for sellers page.

User ID

Unique identifier that each user receives after registering an account, e.g. 62799754. You will receive it in response to GET /me, in the “id” field.