Notification types

id (type) id (str) Description meta Roles
1 registered_finishing_in_3h Auction in tab registered auctions is finishing in 3 hours empty user
2 watchlist_direct_sale_finishing_in_3h Direct Sale from watchlist is finishing in 3 hours empty user
3 watchlist_auction_finishing_in_3h Auction from watchlist is finishing in 3 hours empty user
4 deposit_pending Deposit pending empty user
5 deposit_received Deposit received lot_id (string) user
6 overbid New high bidder lot_id (string) user, admin
7 winner User won a lot lot_id (string) user
8 invoice_attached Seller attached invoice lot_id (string), invoice_id (string) - document id of the invoice user
9 inspection_report_for_registered_auction Inspection report for a lot from registered auctions was received request_id (string) user
10 inspection_report_for_watchlist_direct_sale Inspection report for a direct sale from watchlist request_id (string) user
11 inspection_report_for_watchlist_auction Inspection report for an auction from watchlist request_id (string) user
12 carfax_report_for_registered Carfax report for a lot from registered auction request_id (string) user
13 carfax_report_for_watchlist_direct_sale Carfax report for a direct sale from watchlist request_id (string) user
14 carfax_report_for_watchlist_auction Carfax report for an auction from watchlist request_id (string) user
15 direct_sale_approved Direct sale request was approved lot_id (string) user
16 direct_sale_rejected Direct sale request was rejected user
17 message_from_buyer Message from potential buyer of my direct sale lot lot_id (string), sender_id (string), receiver_id (string) user, admin
18 message_from_seller Message from the seller of the lot I want to buy lot_id (string), sender_id (string), receiver_id (string) user
19 callback_requested User has requested a callback lot_id (string), account_id (string) admin
20 new_active_trade User has registered on a lot (or requested buy now) and paid deposit lot_id (string), account_id (string) admin
21 new_upload User hase made a lot creation request request_id (string) admin
22 look_live_request User paid for look live request request_id (string), lot_id (string) admin
23 carfax_purchase User bought a carfax report request_id (string), lot_id (string) admin
24 reminder_unpaid_deposit_3h Auction is ending in 3h but there's participant with unpaid deposit lot_id (string), account_id(string) admin
25 reminder_unpaid_invoice Invoice is still 'due' 12h after lot is closed lot_id (string) admin
26 auction_finished Auction is finished lot_id (string) admin
27 financing_pending User've just requested financing lot_id (string) user
28 financing_approved Financing request is approved lot_id (string) user
29 financing_rejected Financing request is rejected lot_id (string) user

Get unread notifications count

Returns list of unread notifications count for each notification type.

GET /counts

Responses:

  • 200 OK

    {
      "data": [
          {
              "type": "notifications",
              "id": "14",
              "attributes": {
                  "count": 1,
                  "type_str": "carfax_report_for_watchlist_auction"
              }
          }
      ]
    }
    
  • 401 Unauthorized

Get unread notifications

Returns list of unread notifications. For type and meta description, see notification types

Sorting keys. Default created_at

Key Description
created_at sort by created_at

GET /notifications

Responses:

  • 200 OK

    {
      "data": [
          {
              "type": "notifications",
              "id": "uyErieIJuRUaSbqC",
              "attributes": {
                  "type": 18,
                  "type_str": "message_from_seller",
                  "meta": {
                      "lot_id": "1",
                      "receiver_id": "GBIOUELRPQIXUIXJSXPSDTSHCMJFVUK36GIQOLTZWFYK5NRZCS64UDJB",
                      "sender_id": "GCFFCRD32PLJD2SIQF4O5ZORSRBMRQRTU6KKILR5XO3TWCBTASF3PTTS"
                  },
                  "created_at": "2019-04-08T14:17:37Z" 
              }
          },
          {
              "type": "notifications",
              "id": "QCpWNUulPQswPFBG",
              "attributes": {
                  "type": 8,
                  "type_str": "invoice_attached",
                  "meta": {
                      "invoice_id": "invoice-id",
                      "lot_id": "1"
                  },
                  "created_at": "2019-04-08T14:17:37Z"
              }
          }
      ]
    }
    
  • 401 Unauthorized

Mark notification as read

Mark a notification as read.

Request:

  • DELETE /notifications/{id}

Responses:

  • 204 No Content

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found request with id not found

Mark notifications as read (bulk endpoint)

Mark multiple notifications as read.

Request:

  • POST /notifications
  • Body:
{
    "data": [
        {
            "type": "notifications",
            "id": "uyErieIJuRUaSbqC"
        },
        {
            "type": "notifications",
            "id": "QCpWNUulPQswPFBG"
        }
    ]
}

Response:

  • 204 No Content

Possible errors:

  • 400 Bad Request request body malformed

results matching ""

    No results matching ""