Welcome to GoedGeplaatst RESTful API
The GoedGeplaatst RESTful API enables clients to access all available resources of GoedGeplaatst.
The specifications in this document are a 'work-in-progress' and can be changed at any time.
For documentation of the legacy SOAP API see click here
Important notice
From April 17th 2025 marktplaats, 2dehands and goedgeplaatst will remove the following price models:
- to be discussed
- by request
- trade
- buy it now
The remaining (valid) price-models are:
- fixed
- bidding
- see description
- reserved
Existing advertisements using the absolete price models will be converted by marktplaats/2dehands to see description
New advertisements with these absolete price models will be rejected by the GoedGeplaatst API.
Please update your client-software before this date to prevent advertisements not beïng accepted.
Important notice
From February 28th, 2025 the following attributes will be made mandatory by Marktplaats for DSA (Digital Services Act) authorized business sellers, due to European legislation:
(General Product Safety Regulation (GPSR - EU 2023/988) section 2, art. 19)
- manufacturerTradename
- manufacturerAddress
- manufacturerEmail
This is regarding all new advertisments as well as existing advertisments beïng updated.
In contradiction to what was communicated earlier by Marktplaats, this includes all advertisments regardless whether a user is a DSA Approved Business Seller with payment transactions enabled or not.
You can use the newly introduced parameter userId when using endpoint /attributes/ to determin whether or not the attribute is mandatory for the specified user in the selected category.
In order to assist our clients with this transition, we also introduced a new endpoint to our API: /manufacturers/
This endpoint will allow a client to generate a predefined list of manufacturers which can be used to complete the payload of the /ads/ endpoint in your own application.
This functionality is also available in our webinterface
Terminology
| Label | Description |
|---|---|
Req |
Required |
W |
Writeable |
U |
Updateable |
S |
Searchable |
P |
Patchable |
Versions
| Version | Date | Description |
|---|---|---|
| 1.1 | 2023-09-01 | Added flatrate field to wallet-object |
| 1.2 | 2023-09-27 | Altered fieldnames price / priceAdditional of price-object |
| 1.3 | 2024-02-27 | Added prices-object to /ads GET call |
| 1.4 | 2024-03-12 | Added imagestatus-call |
| 1.5 | 2024-09-13 | Added misc-object to /ads endpoint for miscellaneous fields |
| Added new examples for creating and retrieving ads | ||
| Changed image-object in /ads endpoint to readonly since adding images has it's own endpoint | ||
| 1.6 | 2024-09-25 | Removed autopublish entities from /ads, /users/, /user/settings/ endpoints. |
| 1.7 | 2024-10-25 | Added inverted search-option for parameter searchportal for /ads GET |
| 1.8 | 2024-10-25 | Added extra search parameters to /reports/payments POST |
| 1.9 | 2024-10-29 | Added basic wireflow-chart to documentation |
| 2.0 | 2024-11-07 | Added extra search and order parameters to reports transactions and reports transactions export |
| 2.1 | 2024-11-07 | Added searchkeyword parameter to categories |
| 2.2 | 2024-11-11 | Added allowContactByEmail parameter to useradsettings |
| 2.3 | 2024-11-26 | Added title to list of available order-fields in ads |
| 2.4 | 2024-12-04 | Added images parameter to publish |
| 2.5 | 2024-12-10 | Added important notice to attributes because of mandatory fields introduced by marktplaats.nl / 2dehands.be due to the General Product Safety Regulation |
| 2.6 | 2025-01-07 | Added support for creating and searching for manufacturer info based on brand, category etc., due to mandatory attributes for GPSR. |
| 2.7 | 2025-01-22 | Added support for batch-updating ads with manufacturer info |
| 2.8 | 2025-01-24 | Added parameter searchmanufacturer to ads |
| 2.9 | 2025-02-19 | Limited the date-selection to 1 month for reports transactions |
| 3.0 | 2025-02-24 | Added displayName to features |
| 3.1 | 2025-03-03 | Added DELETE /ads/batch endpoint and PATCH /ads/batch/ endpoint |
| 3.2 | 2025-03-11 | Added PATCH /user/settings endpoint |
Contact
If you wish to contact our helpdesk with questions of want to report a bug, please contact us at the following email-address:
Endpoints
The endpoint of the API is available at the following location:
Production
https://api.goedgeplaatst.nl/rest/v1/
Sandbox
https://dev-api.goedgeplaatst.nl/rest/v1/
Wireflow
Request Methods
An overview of available request-methods (source: developer.mozilla.org)
GET
The GET method requests a representation of the specified resource. Requests using GET should only retrieve data and should not contain a request content.
POST
The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.
PUT
The PUT method replaces all current representations of the target resource with the request content.
DELETE
The DELETE method deletes the specified resource.
PATCH
The PATCH method applies partial modifications to a resource.