Get auctions by UUIDs - Monument Public API

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

auctions

get_by_uuids

Get auctions by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "auctionUuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids"

payload = { "auctionUuids": ["123e4567-e89b-12d3-a456-426614174000"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({auctionUuids: ['123e4567-e89b-12d3-a456-426614174000']})
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'auctionUuids' => [
        '123e4567-e89b-12d3-a456-426614174000'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids"

	payload := strings.NewReader("{\n  \"auctionUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auctionUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auctionUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "auctionUuid": "123e4567-e89b-12d3-a456-426614174000",
    "auctionStage": "SCHEDULED",
    "auctionStartDate": "2024-01-15T10:00:00.000Z",
    "auctionEndDate": "2024-01-15T18:00:00.000Z",
    "minimumBidAmount": 100,
    "winningBidAmount": 250,
    "buyerName": "John Doe",
    "buyerEmail": "buyer@example.com",
    "buyerPhone": "5551234567",
    "auctionScheduledOnDate": "2024-01-10T00:00:00.000Z",
    "auctionCompletedOnDate": "2024-01-16T00:00:00.000Z",
    "auctionCanceledOnDate": "2024-01-14T00:00:00.000Z",
    "cleanOutDate": "2024-01-20T00:00:00.000Z",
    "unitRentalRecordUuid": "123e4567-e89b-12d3-a456-426614174000",
    "contentCategories": [
      "Furniture",
      "Electronics"
    ],
    "content": "Household items and boxes",
    "photos": [
      {
        "url": "https://communication-media.cdn.production.monument.io/auctions/photo1.jpg",
        "isPrimary": true,
        "photoType": "UNIT_CONTENTS"
      }
    ],
    "tamperTagId": "TAG-12345",
    "requiresNotice": false
  }
]

Headers

x-api-key

any

required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid

string<uuid>

required

Body

application/json

auctionUuids

string[]

required

Array of auction UUIDs to retrieve (max 1000)

Example:

["123e4567-e89b-12d3-a456-426614174000"]

Response

Auction details retrieved successfully

auctionUuid

string<uuid>

required

Auction UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

auctionStage

enum<string>

required

Auction stage

Available options:

NOT_SCHEDULED,

SCHEDULED,

PAYMENT_PENDING,

WAITING_FOR_CLEAN_OUT,

COMPLETED,

CANCELED,

UNSOLD

Example:

"SCHEDULED"

auctionStartDate

string<date-time> | null

required

Auction start date

Example:

"2024-01-15T10:00:00.000Z"

auctionEndDate

string<date-time> | null

required

Auction end date

Example:

"2024-01-15T18:00:00.000Z"

minimumBidAmount

number | null

required

Minimum bid amount

Example:

100

winningBidAmount

number | null

required

Winning bid amount

Example:

250

buyerName

string | null

required

Buyer name

Example:

"John Doe"

buyerEmail

string | null

required

Buyer email

Example:

"buyer@example.com"

buyerPhone

string | null

required

Buyer phone

Example:

"5551234567"

auctionScheduledOnDate

string<date-time> | null

required

Date auction was scheduled

Example:

"2024-01-10T00:00:00.000Z"

auctionCompletedOnDate

string<date-time> | null

required

Date auction was completed

Example:

"2024-01-16T00:00:00.000Z"

auctionCanceledOnDate

string<date-time> | null

required

Date auction was canceled

Example:

"2024-01-14T00:00:00.000Z"

cleanOutDate

string<date-time> | null

required

Clean out date

Example:

"2024-01-20T00:00:00.000Z"

unitRentalRecordUuid

string<uuid>

required

Unit rental record UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

contentCategories

string[]

required

Content category descriptions

Example:

["Furniture", "Electronics"]

content

string | null

required

Contents description

Example:

"Household items and boxes"

photos

object[]

required

Auction photos

Show child attributes

tamperTagId

string | null

required

Tamper tag ID

Example:

"TAG-12345"

requiresNotice

boolean

required

Whether the auction requires public notice

Example:

false

Update Auction Buyer DetailsUpdates buyer details for an auction. Transitions SCHEDULED auctions to PAYMENT_PENDING.

Get auctions by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "auctionUuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids"

payload = { "auctionUuids": ["123e4567-e89b-12d3-a456-426614174000"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({auctionUuids: ['123e4567-e89b-12d3-a456-426614174000']})
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'auctionUuids' => [
        '123e4567-e89b-12d3-a456-426614174000'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids"

	payload := strings.NewReader("{\n  \"auctionUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auctionUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auctionUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "auctionUuid": "123e4567-e89b-12d3-a456-426614174000",
    "auctionStage": "SCHEDULED",
    "auctionStartDate": "2024-01-15T10:00:00.000Z",
    "auctionEndDate": "2024-01-15T18:00:00.000Z",
    "minimumBidAmount": 100,
    "winningBidAmount": 250,
    "buyerName": "John Doe",
    "buyerEmail": "buyer@example.com",
    "buyerPhone": "5551234567",
    "auctionScheduledOnDate": "2024-01-10T00:00:00.000Z",
    "auctionCompletedOnDate": "2024-01-16T00:00:00.000Z",
    "auctionCanceledOnDate": "2024-01-14T00:00:00.000Z",
    "cleanOutDate": "2024-01-20T00:00:00.000Z",
    "unitRentalRecordUuid": "123e4567-e89b-12d3-a456-426614174000",
    "contentCategories": [
      "Furniture",
      "Electronics"
    ],
    "content": "Household items and boxes",
    "photos": [
      {
        "url": "https://communication-media.cdn.production.monument.io/auctions/photo1.jpg",
        "isPrimary": true,
        "photoType": "UNIT_CONTENTS"
      }
    ],
    "tamperTagId": "TAG-12345",
    "requiresNotice": false
  }
]