Questions? Feedback? powered by Olark live chat software

Escrow Offer Guide :: Retrieving auction details

Retrieving auction details

Use this endpoint to retrieve information about an auction. This endpoint does not require authentication. Here are the list of attributes which we return:

  • id
  • creation_date
  • currency
  • description
  • items
  • parties
  • include_buy_now
  • lising_reference
  • return_url
1
2
3
curl "https://api.escrow.com/integration/2018-08-01/auction/2d2afb9f-364f-4f9f-82a5-803344d60432" \
    -X GET \
    -H "Content-Type: application/json"

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
        "creation_date": "2019-01-07T06:25:50.503000",
        "currency":"usd",
        "description":"2008 BMW 328xi",
        "include_buy_now": true,
        "listing_reference":"listing-xyz456",
        "id": 123123,
        "parties":[
           {
             "customer":"buyer_user",
             "role":"buyer",
             "agreed": true,
             "initiator": true
           },
           {
              "customer":"john.wick@escrow.com",
              "role":"seller",
              "agreed": true
           },
           {
              "customer":"john.wick@escrow.com",
              "role":"partner",
              "agreed": true
           },
        ],
        "items": [
             {
                 "title": "2008 BMW 328xi",
                 "description": "A great car for the snow",
                 "type": "motor_vehicle",
                 "inspection_period": 259200,
                 "quantity": 1,
                 "schedule": [
                     {
                         "amount": 5000.0,
                         "payer_customer": "buyer_user",
                         "beneficiary_customer": "john.wick@escrow.com"
                     }
                 ],
                 "extra_attributes": {
                     "make": "BMW",
                     "model": "328xi",
                     "year": 2008
                 }
             }
        ]
}