Hand a lot over

POST

https://{organization}.rescueconsole.com

api

fundraising

items

{id}

collected

Hand a lot over

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/fundraising/items/{id}/collected \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collected": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({collected: true})
};

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

import requests

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

payload = { "collected": True }
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>",
  "current_bid_cents": 123,
  "leading_bidder_id": "<string>",
  "bid_count": 123,
  "winner_bidder_id": "<string>",
  "winning_bid_cents": 123,
  "deductible_cents": 123,
  "closed_at": "<string>",
  "paid_at": "<string>",
  "collected_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)"
}

{
  "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 lot's id.

Body

application/json

collected

boolean

default:true

False undoes it.

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

ONLY WHAT A WINNER PAYS ABOVE THIS IS TAX DEDUCTIBLE, and three answers are possible. Omit the field, or send null, to say nobody has worked it out: a receipt can then claim no deductible amount. Send 0 to say the winner receives nothing of value, which makes the whole bid deductible - a claim you are making, and usually right for a donated service. Send a number for what the winner receives. Omitting it and sending 0 are NOT the same thing.

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

current_bid_cents

integer | null

What the lot stands at. Null until somebody has bid.

leading_bidder_id

string | null

bid_count

integer

winner_bidder_id

string | null

winning_bid_cents

integer | null

What the lot stood at when the bidding stopped.

deductible_cents

integer | null

What the winner may deduct: the winning bid above the lot's fair market value. NULL IS NOT ZERO. Null means no fair market value was recorded, so no deductible amount can be claimed at all; zero means the bid was at or under the value and none of it was a gift.

closed_at

string | null

When closing decided this lot. Present on a lot with no bids too: closed and undecided are different things.

paid_at

string | null

collected_at

string | null

⌘I

Hand a lot over

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/fundraising/items/{id}/collected \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collected": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({collected: true})
};

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

import requests

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

payload = { "collected": True }
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>",
  "current_bid_cents": 123,
  "leading_bidder_id": "<string>",
  "bid_count": 123,
  "winner_bidder_id": "<string>",
  "winning_bid_cents": 123,
  "deductible_cents": 123,
  "closed_at": "<string>",
  "paid_at": "<string>",
  "collected_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)"
}

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

Using the API

Endpoints

Authorizations

Path Parameters

Body

Response