Bids Retrieve

This endpoint can be used to retrieve bids received through a portal.

Reference

POST /bids/retrieve/

Retrieve bids of one advertisement from the specified user. When no adId has been specified, all bids for active advertisements will be returned.

New / unread items are shown first in the result set, latest bids first.

General Search parameters

field	type	description/constraints	Req	W	U
useCache	boolean	Use API caching module Default: false	No	No	No
page	int	Show page x from resultset (default: 1)	No	No	No
itemsPerPage	int	Number of items per page Minimum: 1 item Maximum 100 items (default: 25)	No	No	No
userId	int	The userId	Yes	No	No
adId	int/array	The adId	No	No	No
status	array	Include advertisements with the following status:	No	No	No
		- concept
		- active
		- archive
		- removed

Fields

field	type	constraints	W	U
adId	int	The adId	No	No
bids	array	List of bid-object	No	No

Fields bid-object

field	type	constraints	W	U
portal	string	Available options:	No	No
		- marktplaats
		- tweedehands
		- website
adId	int	The adId	No	No
title	string	The ad-title	No	No
thumb	boolean/string	Thumbnail url	No	No
status	string	The ad-status	No	No
bidId	int/string	The bidId	No	No
		marktplaats: int
		tweedehands: int
		website: string
bidderId	boolean/int	The bidderId when applicable. (Depending on the portal)	No	No
nickname	string	The nickname of the bidder	No	No
amount	int	The bid-amount in whole cents	No	No
date	datetime	The date/time the bid was made	No	No
unread	boolean	Is this bid unread / new ?	No	No
replies	boolean/array	List of reply-objects	No	No

Fields Reply-object

field	type	constraints	W	U
message	text	max 65.536 characters	No	No
phoneNumber	string	max 20 characters	No	No
date	datetime		No	No

Example retrieving bids

Request

GET /rest/v1/bids/retrieve/12311/659593 HTTP/2

or

POST /rest/v1/bids/retrieve/ HTTP/2

{
  "page": 1,
  "itemsPerPage": 100,
  "userId": 12311,
  "adId": [
    659593
  ]
}

Response

{
  "result": true,
  "fromCache": false,
  "totalItems": 8,
  "totalInSet": 8,
  "page": 1,
  "itemsPerPage": 50,
  "speed": 0.00007009506225585938,
  "data": [
    {
      "portal": "marktplaats",
      "adId": 659593,
      "title": "Test Advertentie Helpdesk",
      "thumb": "https://img.goedgeplaatst.nl/659593/1/?w=100&h=100&ps=1",
      "status": "active",
      "bidId": 6739,
      "bidderId": 18887085,
      "nickname": "test user marktplaats",
      "amount": 1006,
      "date": "2021-07-02 10:27:33",
      "unread": true,
      "replies": false
    },
    {
      "portal": "tweedehands",
      "adId": 659593,
      "title": "Test Advertentie Helpdesk",
      "thumb": "https://img.goedgeplaatst.nl/659593/1/?w=100&h=100&ps=1",
      "status": "active",
      "bidId": 6738,
      "bidderId": 18887085,
      "nickname": "test user tweedehands",
      "amount": 1005,
      "date": "2021-07-02 10:15:00",
      "unread": false,
      "replies": [
        {
          "message": "Bedankt voor het bod, ...",
          "phoneNumber": "",
          "date": "2021-07-02 12:22:28"
        }
      ]
    },
    {
      "portal": "website",
      "adId": 659593,
      "title": "Test Advertentie Helpdesk",
      "thumb": "https://img.goedgeplaatst.nl/659593/1/?w=100&h=100&ps=1",
      "status": "archive",
      "bidId": "1e3d76d892737f3d7f91b1bf6a465a27",
      "bidderId": false,
      "nickname": "test user website",
      "amount": 1500,
      "date": "2021-07-02 09:13:33",
      "unread": false
    }
  ]
}