OLX Partner API
OLX Europe shares public API for its partners. It allows to easily integrate with local sites by posting, managing adverts and communicating with OLX users…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
OLX Europe shares public API for its partners. It allows to easily integrate with local sites by posting, managing adverts and communicating with OLX users via internal messaging system. API documentation is the same for every OLX across the Europe.
Versioning
- Major version is reserved for completely new version or redesigned API
- Minor version is for potentially backward incompatible changes (e.g. field is removed/added/changed name, etc)
- We do not support “bugfix” part of the versioning as minor versioning is enough in this case - if bugfix has backward incompatible change, it will bump up minor version.
- Version is defined using Version header (e.g. If you want to use endpoint in version 2.0, just send request with header “Version: 2.0”).
- Version header is required.
- Enums are additive. Adding a new enum value, in request or response, is not treated as a breaking change and does not bump the version. Clients must handle unknown enum values gracefully (e.g. ignore or fall back to a default) instead of failing.
Language
- In multilingual countries (like Ukraine) switching between languages is supported by sending header “Accept-Language: xx” where xx is language code
- There are two endpoints exposing available languages and currencies (see endpoints references below).
Authentication
OAuth 2.0
OLX API implements OAuth2 standard. For more information you can visit https://www.oauth.com/oauth2-servers/definitions/.
Basic principle of OAuth is one point of authorization and accessing all of resources with access token, granting (or not) access to certain endpoints.
OAuth access token is string which should be passed to every request made to OLX API endpoints. Token is valid for certain amount of time, after that application have to send request with refresh token to receive new token.
Remember Access token is like password - when someone obtains token, then gains full access to given account, limited only by token scope.
In order to use API partner should request to receive API Client data. One partner may have more than one application eligible for OLX API, each with different set of credentials. Basic API credentials are client_id and client_secret - both are required regardless of selected authentication method.
Credentials
Please store client_id, client_secret in safe place, as it will be needed to complete configuration and authentication process.
How to obtain Access Token
In order to receive token, client should send POST request to /api/open/oauth/token. Required fields:
{
"grant_type": "",
"client_id": "",
"client_secret": "",
"scope": "v2 read write"
}client_id and client_secret are data you have received from OLX business person. scope is requested token scope, but limited by partner settings - basically “v2”, “read” and “write”.
Depends on grant type, request should contain other necessary fields.
As response client will receive:
{
"access_token": "454c3cd39a980500e9b787e03d53ec5c320f644b",
"expires_in": 86400,
"token_type": "bearer",
"scope": "v2 read write",
"refresh_token": "12a13560163da7901d7f74c89fc5df3ea7625942"
}Access token should be passed with each request to API as header Authorization.
Authorization: Bearer 454c3cd39a980500e9b787e03d53ec5c320f644b
Field expires_in defines how many more seconds since now (now = last request to oauth/token endpoint) access token will be valid.
Refresh token is valid for one month (2592000 seconds). Also it can be changed when new access token is generated.
Please store access token and refresh token in safe place.
Supported grant types
| Grant Type | Context | Actions |
|---|---|---|
| authorization_code | User | Add or fetch adverts adverts / messages, etc. |
| client_credentials | Client | Fetch config data: categories, cities, etc. |
| refresh_token | User or Client |
Scopes
Scopes are specific permissions for API usage as a given user type. The authorization and token endpoints allow your application to specify the scope of the access request.
Each API endpoint can demand access token with the specific scope. See the endpoint reference for information about required scope.
Please note your application has closed list of allowed scopes, so you should ensure you are able to ask about given scope and always verify the scopes of issued token.
Default scopes are: v2 read write.
Grant type: authorization_code
Requirements:
Client must specify Callback URL. You can specify more than one Callback URL. Please avoid special chars like & (multiple), # in Callback URL.
Flow:
On Application site user clicks on button “Authenticate with OLX”.
Auth URL: /oauth/authorize/?client_id=XXX&response_type=code&state=XXX&scope=read write…
Endpoints 63
Users
- GETGet authenticated user
/users/meGet currently Authenticated User - GETGet user
/users/:idGet any User - GETGet account balance
/users/me/account-balance - GETGet available payment methods
/users/me/payment-methods
Cities & Districts
- GETList of country regions
/regions - GETGet region
/regions/:regionId - GETGet cities
/citiesGet list of cities - GETGet city
/cities/:cityId - GETGet city districts
/cities/:cityId/districts - GETGet districts
/districts - GETGet district
/districts/:districtId - GETGet locations
/locations?latitude=0.0&longitude=0.0
Languages & currencies
- GETGet languages
/languagesGet site available languages - GETGet currencies
/currenciesGet site available currencies
Delivery
- GETGet delivery settings
/delivery/settingsGet delivery settings
Categories & attributes
- GETGet categories
/categories - GETGet category
/categories/:categoryId - GETGet category attributes
/categories/:categoryId/attributesRetrieves attribute definitions for a given category. Please note that there are two kinds of attributes, the first enumerates the attributes available in… - GETGet category suggestions
/categories/suggestion?q=stringGets category suggestions for a given Ad title
Threads & messages
- GETGet threads
/threadsReturns threads for the authenticated user. Each thread includes a uuid field - store and use it as the preferred identifier in subsequent API calls. Numeric… - GETGet thread
/threads/:threadIdReturns a single thread. Prefer addressing the thread by UUID in the path parameter. Numeric thread ID is deprecated but still accepted for backward… - GETGet messages
/threads/:threadId/messagesReturns messages from the given thread. Prefer addressing the thread by UUID in the path parameter. Numeric thread and message IDs in responses are deprecated… - POSTPost Message
/threads/:threadId/messagesPosts a new message in the given thread. Prefer addressing the thread by UUID in the path parameter. Field phone is optional and depends on the category —… - GETGet message
/threads/:threadId/messages/:messageIdReturns a single message. Prefer UUID identifiers in path parameters (threadId, messageId). Numeric thread and message IDs are deprecated but still accepted… - GETDownload message attachment
/threads/:threadId/messages/:messageId/attachments/:attachmentIndexDownloads a file attached to a message. The attachments[].url field in GET message and GET messages responses points to this endpoint. Use the url value from… - POSTTake action on thread
/threads/:threadId/commandsExecutes a command on the given thread. Prefer addressing the thread by UUID in the path parameter. Numeric thread ID is deprecated but still accepted for…
Paid features
- GETGet available paid features
/paid-features - GETGet active paid features
/adverts/:advertId/paid-features - POSTPurchase paid feature
/adverts/:advertId/paid-features
Adverts
- GETGet user adverts
/adverts - POSTCreate advert
/advertsValidation rules * Following characters cannot be provided in the title and in the description three times in a row: ! ? . , - = + # % & @ * _ > < : ( ) | *… - GETGet advert
/adverts/:advertId - PUTUpdate advert
/adverts/:advertIdAll parameters and validation rules are the same as in Create advert section. For Pay & Ship stock on the Polish market, use this endpoint to update an… - DELETEDelete advert
/adverts/:advertIdPermanently removes an advert. The advert MUST NOT be in active status — deactivate it first via POST /adverts/{advertId}/commands with command: deactivate… - POSTTake action on advert
/adverts/:advertId/commands
Advert logo
- GETGet advert logos
/adverts/:advertId/logos - POSTAdd logo
/adverts/:advertId/logos - DELETEDelete logo
/adverts/:advertId/logos/:logoId
Users Business
- GETGet user business data
/users-business/me - PUTUpdate user business data
/users-business/me - GETGet user business logos
/users-business/me/logos - POSTSet user business logo
/users-business/me/logos - DELETERemove user business logo
/users-business/me/logos/:logoId - GETGet user business banners
/users-business/me/banners - POSTSet user business banner
/users-business/me/banners - DELETERemove user business banner
/users-business/me/banners/:bannerId
Packets
- GETGet available packets
/packets?category_id=0Returns packets that can be purchased in the given category, with prices calculated for the authenticated user. Use the returned size, is_premium and type… - GETGet available location zones - regional pricing feature has to be enabled (Available in UA)
/zones?category_id=0 - GETGet bought packets
/users/me/packets - POSTPurchase packet
/users/me/packetsPurchases a packet for the authenticated user. The packet is identified by category_id, size, is_premium and type - use the values returned by GET /packets… - POSTPurchase packet for an advert
/adverts/:advertId/packets
Payments
- GETGet billing
/users/me/billing - GETGet prepaid invoices
/users/me/prepaid-invoicesThis endpoint is available only for BG and PL. - GETGet postpaid invoices
/users/me/postpaid-invoicesThis endpoint is available only for OLX.pl
Order
- POSTAccept a partner-managed order
/orders/:orderId/acceptAccepts an order on behalf of the seller, moving it into the fulfillment workflow. Optionally submit payout method, payout details, sender details, and terms… - GETGet accept-requirements for a partner-managed order
/orders/:orderId/accept-requirementsChecks whether an order can be accepted and lists any missing requirements that must be fulfilled first. This is a read-only operation with no side effects -… - POSTReject a partner-managed order
/orders/:orderId/rejectRejects an order on behalf of the seller before acceptance, indicating inability or unwillingness to fulfill. Use this for orders in pending confirmation… - POSTCancel a partner-managed order
/orders/:orderId/cancelCancels an accepted order on behalf of the seller when fulfillment cannot proceed. Accepted orders cancel immediately. Orders awaiting dispatch cancel… - GETSearch available posting windows for a partner-managed order
/orders/:orderId/posting-windowsRetrieves available time windows for package pickup to present delivery scheduling options to sellers during order acceptance. Specify a preferred time window… - GETGet Order Details
/orders/:orderIdReturns the seller-facing snapshot of a partner-managed order, including status, items, amounts, shipment, and buyer invoice data. Use this read-only call to… - GETDownload Shipping Label
/orders/:orderId/labelDownloads the shipping label PDF for a partner-managed order so the seller can print it and hand the parcel to the carrier. Call this only when order details…
Status
- GETList Changed Order IDs
/status/orders?since=2026-05-11T10:00:00ZLists the identifiers of orders that changed since a checkpoint you control, so you can keep your own records in step with marketplace activity by pulling… - GETList Changed Ad IDs
/status/adverts?since=2026-05-11T10:00:00ZLists the identifiers of ads that changed since a checkpoint you control, so you can keep your own listing records in step with marketplace activity by…
API details
- Base URL
https://www.olx.pl/api/partner- Authentication
- OAuth 2.0 (authorization code, client credentials flows) with 3 scopes
- Operations
- 63 operations on 56 pathsGET 44POST 13DELETE 4PUT 2
- Main resources
- Cities & Districts 8Users Business 8Order 7Threads & messages 7Adverts 6Packets 5Categories & attributes 4Users 4Advert logo 3Paid features 3
- Response formats
application/jsonapplication/octet-streamapplication/pdf- Description format
- OpenAPI 3.0.2, API version
2.0 - Links
- OpenAPI document
- Listed from
- Olx's published OpenAPI description
How to test the OLX Partner API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the OLX Partner API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code, client credentials flows) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get authenticated user” (GET /users/me), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the OLX Partner API?
OLX Europe shares public API for its partners. It allows to easily integrate with local sites by posting, managing adverts and communicating with OLX users… It is listed under E-commerce and has 63 endpoints.
Who publishes the OLX Partner API?
It is listed from Olx's public API description (an OpenAPI document), not published by Olx on Swastik Codes. Anyone who controls olx.pl can claim the profile by adding a DNS TXT record.
What is the base URL of the OLX Partner API?
Requests go to https://www.olx.pl/api/partner. Endpoint paths are added to this base URL.
How do I authenticate with the OLX Partner API?
With OAuth 2.0 (authorization code, client credentials flows) with 3 scopes.
How many endpoints does the OLX Partner API have?
63 operations on 56 paths (44 GET, 13 POST, 4 DELETE, 2 PUT). The largest groups are Cities & Districts, Users Business, Order, Threads & messages.
Is forking the OLX Partner API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.