Add a lot

POST

https://{organization}.rescueconsole.com

api

fundraising

auctions

{id}

items

Add a lot

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/fundraising/auctions/{id}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "lot_number": "<string>",
  "description": "<string>",
  "category": "<string>",
  "starting_bid_cents": 123,
  "bid_increment_cents": 123,
  "fair_market_value_cents": 123,
  "donor_person_id": "<string>",
  "donor_credit": "<string>",
  "photo_file_ids": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    lot_number: '<string>',
    description: '<string>',
    category: '<string>',
    starting_bid_cents: 123,
    bid_increment_cents: 123,
    fair_market_value_cents: 123,
    donor_person_id: '<string>',
    donor_credit: '<string>',
    photo_file_ids: ['<string>']
  })
};

fetch('https://{organization}.rescueconsole.com/api/fundraising/auctions/{id}/items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/fundraising/auctions/{id}/items"

payload = {
    "name": "<string>",
    "lot_number": "<string>",
    "description": "<string>",
    "category": "<string>",
    "starting_bid_cents": 123,
    "bid_increment_cents": 123,
    "fair_market_value_cents": 123,
    "donor_person_id": "<string>",
    "donor_credit": "<string>",
    "photo_file_ids": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "name": "<string>",
  "lot_number": "<string>",
  "description": "<string>",
  "category": "<string>",
  "starting_bid_cents": 123,
  "bid_increment_cents": 123,
  "fair_market_value_cents": 123,
  "donor_person_id": "<string>",
  "donor_credit": "<string>",
  "photo_file_ids": [
    "<string>"
  ],
  "status": "available",
  "id": "<string>",
  "auction_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Authorizations

Authorization

string

header

required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

string

required

The auction's id.

Body

application/json

name

string

required

lot_number

string | null

Unique within the auction where given.

description

string | null

Response

The lot.

name

string

required

lot_number

string | null

Unique within the auction where given.

description

string | null

category

string | null

Your own word. Nothing is fixed.

starting_bid_cents

integer

bid_increment_cents

integer | null

Overrides the auction's for this lot.

fair_market_value_cents

integer | null

donor_person_id

string | null

Somebody already on your people list.

donor_credit

string | null

Only when it differs from their name on file.

photo_file_ids

string[]

status

enum<string>

unsold means the auction closed and nobody bid, which is different from withdrawn. Both are set by closing, not by hand.

Available options:

available,

withdrawn,

unsold,

sold

string

auction_id

string

created_at

string

updated_at

string

⌘I

Add a lot

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/fundraising/auctions/{id}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "lot_number": "<string>",
  "description": "<string>",
  "category": "<string>",
  "starting_bid_cents": 123,
  "bid_increment_cents": 123,
  "fair_market_value_cents": 123,
  "donor_person_id": "<string>",
  "donor_credit": "<string>",
  "photo_file_ids": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    lot_number: '<string>',
    description: '<string>',
    category: '<string>',
    starting_bid_cents: 123,
    bid_increment_cents: 123,
    fair_market_value_cents: 123,
    donor_person_id: '<string>',
    donor_credit: '<string>',
    photo_file_ids: ['<string>']
  })
};

fetch('https://{organization}.rescueconsole.com/api/fundraising/auctions/{id}/items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/fundraising/auctions/{id}/items"

payload = {
    "name": "<string>",
    "lot_number": "<string>",
    "description": "<string>",
    "category": "<string>",
    "starting_bid_cents": 123,
    "bid_increment_cents": 123,
    "fair_market_value_cents": 123,
    "donor_person_id": "<string>",
    "donor_credit": "<string>",
    "photo_file_ids": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "name": "<string>",
  "lot_number": "<string>",
  "description": "<string>",
  "category": "<string>",
  "starting_bid_cents": 123,
  "bid_increment_cents": 123,
  "fair_market_value_cents": 123,
  "donor_person_id": "<string>",
  "donor_credit": "<string>",
  "photo_file_ids": [
    "<string>"
  ],
  "status": "available",
  "id": "<string>",
  "auction_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Using the API

Endpoints

Authorizations

Path Parameters

Body

Response