> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rescueconsole.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Mark a lot ready to pick up, or shipped

> The step before handing over, and the winner told once (by the bell, by email as their bid notices go, and by text where they asked). Send `{"ready": true, "note": "..."}` for a lot picked up (the note says where and when) or `{"shipped": true, "tracking": "...", "note": "..."}` for a lot shipped; `false` undoes either and tells nobody. Handed over (delivered, for a shipped lot) is still `/collected`. Only a lot somebody won. Needs **write** on Fundraising.



## OpenAPI

````yaml /api-reference/openapi.json post /api/fundraising/items/{id}/fulfillment
openapi: 3.1.0
info:
  title: RescueConsole API
  version: '2026-11-04'
  description: >-
    Your own organization's records, from your own software. There is no
    sandbox: every request goes to your live organization.
servers:
  - url: https://{organization}.rescueconsole.com
    description: Your own organization's address, the one you sign in at.
    variables:
      organization:
        default: your-rescue
        description: >-
          The first part of the address you sign in at. A key only works at the
          address of the organization it was made in.
security:
  - apiKey: []
tags:
  - name: Animals
    description: The animals in your care, and the ones you have placed.
  - name: Animal notes
    description: Notes written on an animal's record.
  - name: Animal weights
    description: An animal's weight readings, one per weighing.
  - name: Animal temperatures
    description: >-
      An animal's temperatures, as typed, with its exams' own read in and the
      species' usual range.
  - name: Animal readiness
    description: >-
      What an animal still needs before it goes on the public site, and
      publishing it.
  - name: Animal day
    description: What was done for an animal today, what is due, and feedings.
  - name: Animal medical records
    description: >-
      Vaccines, treatments, procedures, tests, exams and other medical records
      on one animal.
  - name: Animal placements
    description: The people an animal came from or has been placed with, over time.
  - name: Animal nutrition
    description: 'What an animal eats: its feeding list and its diet.'
  - name: Animal relationships
    description: Siblings, parents, offspring and bonded pairs.
  - name: Animal tags
    description: Your own short labels on an animal.
  - name: Breeds
    description: The breed or kind lists your intake form offers for each species.
  - name: Litters
    description: Litters, and the animals born into them.
  - name: Locations and housing
    description: >-
      The places animals are housed at each of your locations: campuses,
      buildings, rooms and cages, the tunnels that join cages into one space,
      and who is in each.
  - name: Foster homes
    description: >-
      The people who foster for you, what each home can take, and the animals
      offered to and placed with them.
  - name: Intakes
    description: >-
      How each animal arrived: the route in, who brought it, why it was given up
      and the state it came in.
  - name: Medical due
    description: >-
      Medical work that is outstanding across all your animals, and one medical
      record added to many animals at once.
  - name: Transports
    description: >-
      Transport runs: a chain of drives, each leg with its own driver, that
      moves animals from one place to another.
  - name: Animal calendar
    description: >-
      The dated things in animal care on one calendar: medical work due,
      adoptions, foster placements starting and ending, arrivals, and meet and
      greets.
  - name: Animal reports
    description: >-
      The operations report: intakes, outcomes, live release rate and the
      animals in your care, each figure with its own definition.
  - name: Costs
    description: >-
      What the rescue spends, on an animal or on itself: vet bills, food,
      supplies, boarding, each with its receipt in Documents, and what each
      animal has cost.
  - name: Rounds
    description: >-
      Daily rounds: a pass through every place an animal in care is housed, each
      place ticked as it is visited, signed off at the end.
  - name: Lost and found
    description: >-
      Reports of pets lost and found, sent by the public from the board on your
      site, read and put on the board by you.
  - name: Field visits
    description: >-
      Work out in the community: strays picked up, welfare checks, colony
      visits, pantry deliveries and owner support; and the TNR colonies a rescue
      cares for.
  - name: Field services
    description: >-
      For an organization that answers animal control calls: cases, with what
      was reported, where, the people and animals involved, the officer on it,
      every visit, call, notice and pickup, and the ordinances broken as
      warnings and citations, until each is closed with an outcome. Off until
      switched on, and the field team's.
  - name: Clinics
    description: >-
      Vaccine, microchip and spay or neuter clinics for the public's own pets:
      the pets on their owners' records, the clinic days, the services offered
      (sale items), and the appointments.
  - name: Behavior plans
    description: >-
      The work toward one goal for one animal: a goal, its phases, how success
      is measured, a lead and a review on a cadence, each review a task on the
      animal and each follow-up recorded. And the library a plan starts from.
  - name: Assessments
    description: >-
      Short assessments done on an animal as often as wanted, each scored
      question a line over time, and the ones your organization sets up. A
      question can fill the animal's Good with fields.
  - name: Enrichment and playgroups
    description: >-
      What an animal was given (walks, play, training, puzzles, time out of the
      kennel), its last time out, and playgroups: each dog's play rated and who
      it played with.
  - name: Behavior desk and case reviews
    description: >-
      What the behavior team has to do on one page, and case reviews: a serious
      outcome signed off by named people, decided by a person, never by the
      software.
  - name: Controlled drugs
    description: >-
      The controlled drugs given under your DEA registration: each bottle, every
      dose, waste and count, only added to. The printed, signed log stays the
      legal record.
  - name: Adoption applications
    description: >-
      Applications to adopt or foster, from first draft to a decision, and the
      adoption contract signed on an approved one.
  - name: Adoptions
    description: >-
      Animals that went home, what each adopter owes and has paid, and closing
      or reversing the adoption.
  - name: Signed contracts
    description: >-
      Contracts signed on an adoption, a foster placement or an intake, each
      kept exactly as it read when it was signed.
  - name: Contract templates
    description: >-
      The contracts your organization has people sign, with the merge fields
      that fill them in.
  - name: Reconciliations
    description: >-
      A payment processor's settlement lines, matched against the adoption
      payments you recorded.
  - name: Adoption holds
    description: >-
      An animal held for one person for a while, in Adoption Pending, with its
      fee taken as a deposit; and how long a hold lasts and what becomes of its
      fee.
  - name: Animal custom fields
    description: >-
      The extra fields your organization adds to animals, housing units and
      adoption applications.
  - name: Age groups
    description: >-
      What counts as a baby, an adult or a senior, per species, which fee rules
      and discounts read.
  - name: Animal statuses
    description: >-
      Your organization's status vocabulary for animal records, and what kind of
      status each one is.
  - name: Application stages
    description: >-
      The steps an adoption or foster application moves through before it is
      decided, in your organization's words.
  - name: Decision reasons
    description: >-
      Why an application is approved or denied, in your organization's words: a
      list for each decision.
  - name: Behavior attributes
    description: >-
      The catalog of behavioral traits, and where a trait with each name may be
      shown beyond the record.
  - name: Cage card templates
    description: >-
      The layouts your organization prints for the kennel door: paper, fields,
      photo and QR code.
  - name: Adoption fee schedules
    description: >-
      The rules that suggest an animal's adoption fee, and the discounts laid
      over them.
  - name: Medical catalog
    description: >-
      The diagnoses, tests, vaccines, treatments, procedures, conditions and
      medications your medical records pick from.
  - name: Medical protocols
    description: >-
      Your lists of what each species and age group is given, and when. Applying
      one adds ordinary medical records, due on their days.
  - name: Exam forms
    description: >-
      Forms filled on an animal in one go, such as an intake exam: each answer
      is saved as its own record (a weight, the microchip, medical records, one
      exam record of the findings, a note).
  - name: Clinic sheets
    description: >-
      One of your exam forms for the animals going to a clinic: printed with
      what is on file, typed in afterwards as a grid, and recorded as the form
      filled for each animal.
  - name: Handling levels
    description: >-
      Who may handle an animal, in your organization's words: anyone, trained
      volunteers and staff, or staff only.
  - name: Bites and quarantine
    description: An animal's bite reports, only added to, and the quarantine a bite starts.
  - name: Outcome reasons
    description: >-
      Why an animal was euthanized or died, in your organization's words, and
      whether one must be given.
  - name: Note types
    description: What an animal's notes are filed under, in your organization's words.
  - name: Text templates
    description: Words a note or a medical record's notes start from.
  - name: Jurisdictions
    description: >-
      The towns or counties your animals come from and go to, for a contract
      with each: the ZIP codes and town or city names that are each one, and the
      default a new arrival takes.
  - name: Foster reasons
    description: >-
      Why an animal goes to foster and why it came back: the reasons built in,
      the rescue's own, and whether each question is asked or required.
  - name: Certificate settings
    description: >-
      What a rabies or spay or neuter certificate prints beside its record: the
      rescue's text, whether the vet's signature prints, and each vet's license
      number and signature image.
  - name: People
    description: >-
      The people your organization deals with: adopters, donors, volunteers,
      fosters and everybody else.
  - name: Person notes
    description: Notes written on a person's record.
  - name: Person contacts
    description: >-
      A person's phone numbers and email addresses, one of each kind marked
      primary.
  - name: Person addresses
    description: A person's addresses, one of them primary.
  - name: Person tags
    description: Free-text labels on a person, added and removed one at a time.
  - name: People duplicates
    description: People who look like the same person entered twice, and merging them.
  - name: People custom fields
    description: The fields a person's record carries beyond the standard ones.
  - name: Pet food pantry
    description: >-
      Pet food given to people in your community: the households served and
      their pets, each visit and what went home, and what a month came to in
      pounds. Off until your organization switches it on, and what it keeps
      about the people it serves is your organization's choice.
  - name: Organizations
    description: >-
      The outside organizations your rescue deals with: veterinary practices,
      partner rescues, shelters, suppliers, employers and agencies.
  - name: Organization locations
    description: An organization's places, one of them the main one.
  - name: Affiliations
    description: >-
      Who works at, volunteers for or otherwise belongs to an organization, now
      or in the past.
  - name: Forms
    description: >-
      The forms your organization publishes, such as an adoption application or
      a volunteer sign-up, and the questions on them.
  - name: Submissions
    description: >-
      What people sent through your forms, and what your team does with each
      one.
  - name: Tasks
    description: >-
      To-dos, on a record or for the whole organization, narrowed to the records
      your key may read.
  - name: Calendar
    description: >-
      The dated work across your organization in one list, narrowed to the areas
      your key may read.
  - name: Activity
    description: >-
      What was created, changed and deleted in your organization, narrowed to
      the areas your key may read.
  - name: Shift schedules
    description: >-
      Schedules: the occasions shifts are grouped under, such as an adoption day
      or Saturday kennel cover.
  - name: Shift windows
    description: >-
      Shifts: a stretch of time at a place, with the volunteer roles it needs
      and how many of each (the address calls a shift a window).
  - name: Shift bookings
    description: >-
      Sign-ups: a person taking a role on a shift, giving it up, and the hours
      they worked.
  - name: Volunteers
    description: >-
      The people who volunteer: where each stands, what they have done, and
      where they would rather work.
  - name: Volunteer roles
    description: >-
      The jobs a volunteer can sign up for, such as Dog walker or Adoption
      counselor.
  - name: Volunteer qualifications
    description: 'Approvals: who may take which role, and at which location.'
  - name: Shift policies
    description: The rules you set for sign-ups and cancellations.
  - name: Shift calendar
    description: Schedules and shifts as calendar items for a date range.
  - name: Shift custom fields
    description: Your own fields on schedules, shifts and sign-ups.
  - name: Events
    description: >-
      The occasions your rescue hosts: adoption days, fundraisers, clinics and
      the rest.
  - name: Events calendar
    description: Your events between two days, as calendar entries.
  - name: Event tickets
    description: >-
      Tickets to an event, sold on its public page: the ticket types and codes,
      the guest list, and checking guests in at the door.
  - name: Campaigns
    description: >-
      Appeals you raise money for, each with its goal and what it has raised so
      far.
  - name: Donations
    description: 'Gifts of money: how much, from whom, and what they were given to.'
  - name: Donors
    description: The people who have given, with what each has given in all.
  - name: Wish list
    description: The things your rescue needs, and the deliveries that met them.
  - name: Auctions
    description: >-
      Gala auctions and the lots in them. An auction may be part of a campaign,
      so what it raises lands with the rest of that campaign's money, or stand
      on its own.
  - name: Fundraising custom fields
    description: Your organization's own fields on donations and campaigns.
  - name: Funds and appeals
    description: >-
      What a giver said their money is for, and what made them give: two
      different questions, kept apart.
  - name: Sales
    description: >-
      What crosses the counter that is not an adoption fee or a gift: the things
      you sell, and each sale by card, cash or check.
  - name: Message templates
    description: >-
      Saved wording your organization sends again and again, with merge fields
      filled from your records.
  - name: Sending
    description: >-
      Everything here sends real email from your organization, and none of it
      can be unsent.
  - name: Message log
    description: >-
      The email your organization has sent or tried to send, and what became of
      each message.
  - name: Conversations
    description: >-
      The email conversations in your organization's inboxes, and the records
      each one is about.
  - name: Inboxes
    description: >-
      The addresses your organization receives email at, and who may read each
      one.
  - name: Contact preferences
    description: >-
      Whether a person has asked not to be emailed, altogether or about one kind
      of message.
  - name: Suppressions
    description: >-
      Addresses no email goes to, because mail to them bounced or their owner
      asked not to be written to.
  - name: Sender and deliverability
    description: Who your organization's email goes out as, and how much of it arrives.
  - name: Registry flags
    description: >-
      Safety flags your organization files about a person or an animal, which
      other organizations using RescueConsole can see once the flag is vetted
      and shared.
  - name: Registry reviews
    description: >-
      Another organization's vote on a flag it did not file, which decides
      whether the flag becomes active or disputed.
  - name: Registry search
    description: >-
      The lookup by microchip number that anybody may make, with or without a
      key.
  - name: Registry marks
    description: >-
      Where a flag from another rescue matches one of YOUR records. A mark is a
      pointer with no narrative on it: it says what kind of thing was filed and
      which identifier matched, and reading the flag itself goes through the
      flag endpoints, which decide for themselves who may see what.
  - name: Status
    description: >-
      What the public status page at status.rescueconsole.com says, in
      RescueConsole's own shape. Public, like the status page itself: no key is
      needed.
paths:
  /api/fundraising/items/{id}/fulfillment:
    post:
      tags:
        - Auctions
      summary: Mark a lot ready to pick up, or shipped
      description: >-
        The step before handing over, and the winner told once (by the bell, by
        email as their bid notices go, and by text where they asked). Send
        `{"ready": true, "note": "..."}` for a lot picked up (the note says
        where and when) or `{"shipped": true, "tracking": "...", "note": "..."}`
        for a lot shipped; `false` undoes either and tells nobody. Handed over
        (delivered, for a shipped lot) is still `/collected`. Only a lot
        somebody won. Needs **write** on Fundraising.
      operationId: markAuctionLotFulfillment
      parameters:
        - name: id
          in: path
          required: true
          description: The lot's id.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ready:
                  type: boolean
                  description: 'A lot picked up: ready, or not after all.'
                shipped:
                  type: boolean
                  description: 'A lot shipped: on its way, or not after all.'
                tracking:
                  type: string
                  nullable: true
                  maxLength: 300
                note:
                  type: string
                  nullable: true
                  maxLength: 500
                  description: >-
                    Said to the winner: where and when to collect it, or the
                    carrier.
      responses:
        '200':
          description: The lot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuctionItem'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
components:
  schemas:
    AuctionItem:
      allOf:
        - $ref: '#/components/schemas/AuctionItemInput'
        - type: object
          properties:
            id:
              type: string
            auction_id:
              type: string
            created_at:
              type: string
            updated_at:
              type: string
            current_bid_cents:
              type: integer
              nullable: true
              description: What the lot stands at. Null until somebody has bid.
            leading_bidder_id:
              type: string
              nullable: true
            bid_count:
              type: integer
            winner_bidder_id:
              type: string
              nullable: true
            winning_bid_cents:
              type: integer
              nullable: true
              description: What the lot stood at when the bidding stopped.
            closed_at:
              type: string
              nullable: true
              description: >-
                When closing decided this lot. Present on a lot with no bids
                too: closed and undecided are different things.
            paid_at:
              type: string
              nullable: true
            collected_at:
              type: string
              nullable: true
            quantity_sold:
              type: integer
            quantity_left:
              type: integer
            reserve_met:
              type: boolean
              nullable: true
              description: >-
                Whether the bidding has reached the reserve. Null with no
                reserve.
            reserve_not_met:
              type: boolean
              description: The lot closed under its reserve and was not sold.
            extended_until:
              type: string
              nullable: true
              description: Where a late bid has moved the lot's close.
            bought_from_item_id:
              type: string
              nullable: true
              description: >-
                Set on a Buy Now purchase from a lot of several: the lot it was
                bought from. Such a purchase is a sold row of its own, on the
                winners list.
            bought_quantity:
              type: integer
              nullable: true
            bought_now_at:
              type: string
              nullable: true
            fulfillment:
              type: string
              enum:
                - pickup
                - shipping
              description: >-
                How the lot reaches its winner. pickup unless set. Cannot change
                once the lot is ready, shipped or handed over. A Buy Now
                purchase goes the way its lot does.
            ready_at:
              type: string
              nullable: true
              description: When a lot picked up was marked ready, and its winner told.
            shipped_at:
              type: string
              nullable: true
              description: When a shipped lot was marked shipped, and its winner told.
            tracking:
              type: string
              nullable: true
              description: The shipped lot's tracking number.
    AuctionItemInput:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        lot_number:
          type: string
          nullable: true
          description: Unique within the auction where given.
        description:
          type: string
          nullable: true
        category:
          type: string
          nullable: true
          description: Your own word. Nothing is fixed.
        starting_bid_cents:
          type: integer
        bid_increment_cents:
          type: integer
          nullable: true
          description: Overrides the auction's for this lot.
        fair_market_value_cents:
          type: integer
          nullable: true
          description: >-
            What the winner receives is worth, which their receipt states, and
            three answers are possible. Omit the field, or send null, to say
            nobody has worked it out: the receipt then says no value has been
            recorded. Send 0 to say the winner receives nothing of value - a
            statement 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:
          type: string
          nullable: true
          description: Somebody already on your people list.
        donor_credit:
          type: string
          nullable: true
          description: Only when it differs from their name on file.
        photo_file_ids:
          type: array
          items:
            type: string
          description: >-
            Up to twelve of your image files, in the order shown; the first is
            the one on the lot's card. Upload with owner_type auction_item. A
            file that is not one of your images is refused, naming it.
        status:
          $ref: '#/components/schemas/AuctionItemStatus'
        buy_now_cents:
          type: integer
          nullable: true
          description: >-
            The price anybody may take the lot at while the bidding is under it.
            Not under the opening bid or the reserve.
        quantity:
          type: integer
          description: >-
            How many there are. Above one, the lot is sold only at
            buy_now_cents, a unit or more at a time, with no bidding, and needs
            buy_now_cents. 1 to 1000; 1 unless set. Not fewer than have been
            bought.
        reserve_cents:
          type: integer
          nullable: true
          description: >-
            The least you will sell it for. Never shown on your public site.
            Bidding that ends under it does not sell the lot, and the high
            bidder is told. Not on a lot of more than one.
        closes_at:
          type: string
          nullable: true
          description: The lot's own close, as an instant. Null closes it with the auction.
        fulfillment:
          type: string
          enum:
            - pickup
            - shipping
          description: >-
            How the lot reaches its winner. pickup unless set. Cannot change
            once the lot is ready, shipped or handed over. A Buy Now purchase
            goes the way its lot does.
    AuctionItemStatus:
      type: string
      description: >-
        `unsold` means the auction closed and nobody bid, which is different
        from `withdrawn`. Both are set by closing, not by hand.
      enum:
        - available
        - withdrawn
        - unsold
        - sold
  responses:
    Problem:
      description: What is wrong, in one sentence you can show to a person.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: string
          example:
            error: house_trained must be 1, 0 or null (not assessed)
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key from Settings, API keys. It starts with rc_live_.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.