User activity can be retrieved by using the following URL and specifying the user ID, a starting record number and ending record number. If left blank, this will default to the first 50 records. Data is returned in order of auction date, with past auctions at the end of the list. Each auction contains a list of items the user has bid on for that auction, along with their bid and bid type.
| Method | URL |
| GET | https://api.fairwarningsoftware.com/v1.1.1/user/activity/[user-id]/[start]/[limit] |
| Status | Response |
| 200 | { "auctions" : [{ <auction_id> : { "auction_info" : { "auction_name" : <auction_name>, "auction_date" : <auction_date>, "auction_end_date" : <auction_end_date> }, "items" : [{ "item" : { "item_id": <item_id>, "receipt_id": <receipt_id>, "office_id": <office_id>, "storage_id": <storage_id>, "auction_id": <auction_id>, "status_id": <status_id>, "category_id_1": <category_id_1>, "category_id_2": <category_id_2>, "category_id_3": <category_id_3>, "web_category_id_1": <web_category_id_1>, "web_category_id_2": <web_category_id_2>, "web_category_id_3": <web_category_id_3>, "item_advertise": <item_advertise>, "item_lot": <item_lot>, "department_id": <department_id>, "item_consignor_numbers": <item_consignor_numbers>, "item_lot": <item_lot>, "item_lot_suffix": <item_lot_suffix>, "item_buy_it_now": <item_buy_it_now>, "item_timed_auction_start": <item_timed_auction_start>, "item_timed_auction_end": <item_timed_auction_end>, "item_low_estimate": <item_low_estimate>, "item_high_estimate": <item_high_estimate>, "item_start_price": <item_high_estimate>, "item_reserve": <item_reserve>, "item_hammer_price": <item_hammer_price>, "bidder_id": <bidder_id>, "item_width": <item_width>, "item_height": <item_height>, "item_depth": <item_depth>, "item_weight": <item_weight>, "item_overnight_required": <item_overnight_required>, "item_quantity": <item_quantity>, "item_shippable": <item_shippable>, "item_shelf_location": <item_shelf_location>, "item_provenance": <item_provenance>, "item_title": <item_title>, "item_slug": <item_slug>, "item_description": <item_description>, "item_condition": <item_condition>, "item_comments_to_consignor": <item_comments_to_consignor>, "primary_image": { "base" : [url-base], "parts" : { "full" : [url-addition], "large" : [url-addition], "medium" : [url-addition], "thumb" : [url-addition] } }, "bid_type_name" : <bid_type_name>, "bid_amount" : <bid_amount>, "timed_bid_amount" : <timed_bid_amount>, "phone_bid_amount" : <phone_bid_amount>, "high_bidder" : <high_bidder>, "bid_info" : { "high_bid" : <high_bid>, "next_bid" : <next_bid>, "bid_increment" : <bid_increment> }, "user" : { "can_bid" : <can_bid>, "high_bids" : { "bid_amount" : <bid_amount>, "phone_bid_active" : <phone_bid_active>, "phone_bid_amount" : <phone_bid_amount>, "timed_bid_amount" : <timed_bid_amount> } } } ]} } }], "record_count" : <record_count> } |
| 401 | {"error":"The API keys provided are invalid."} |
| 403 | {"error":"API keys are missing."} |
| 500 | {"error": <custom error>} |
| Field | Type | Description |
| item_id | int | The unique identifier for the item |
| receipt_id | int | The ID of the receipt this item belongs to |
| office_id | int | The ID of the office this location is at |
| storage_id | int | The ID of the storage location the item is at |
| auction_id | int | The unique identifier for the auction the item is in |
| status_id | int | The ID for the status applied to this item |
| category_id_1 | int | The primary category ID assigned to this item |
| category_id_1 | int | The secondary category ID assigned to this item |
| category_id_3 | int | The tertiary category ID assigned to this item |
| web_category_id_1 | int | The primary web category ID assigned to this item |
| web_category_id_2 | int | The secondary web category ID assigned to this item |
| web_category_id_3 | int | The tertiary web category ID assigned to this item |
| iitem_advertise | bool | Whether the item was flagged to be advertised |
| department_id | int | The ID for the department set for the item |
| item_consignor_numbers | string | The consignor numbers associated with the item |
| item_lot | int | The lot number given to the item designating it's place in the auction |
| item_lot_suffix | string | The lot suffix associated with an item |
| item_buy_it_now | double | The buy-it-now price assigned to the item |
| item_timed_auction_start | datetime | The date and time bidding for the item starts |
| item_timed_auction_end | datetime | The date and time bidding for the item ends |
| item_low_estimate | double | The low estimate for the item |
| item_high_estimate | double | The high estimate for the item |
| item_start_price | double | The price that the first bid must meet or exceed |
| item_reserve | double | The price that must be matched or exceeded to win the item |
| item_hammer_price | double | The price of the bid placed that won the item |
| bidder_id | int | The user's ID who won the item |
| item_width | double | The width of the widest part of the item |
| item_height | double | The height of the tallest part of the item |
| item_depth | double | The depth of the deepest part of the item |
| item_weight | double | The weight of the item |
| item_overnight_required | bool | Whether the item requires overnight shipping when shipping |
| item_quantity | int | The number of pieces which make up the item lot |
| item_shippable | bool | Whether the item is allowed to be shipped |
| item_shelf_location | string | The location of the item on a shelf |
| item_provenance | string | The place of origin or earliest known history of the item |
| item_title | string | The title of the item |
| item_slug | string | The slug of the item title |
| item_description | string | The description of the item |
| item_condition | string | The condition of the item |
| item_comments_to_consignor | string | Comments only for the consignor to see |
| primary_image | object | An object containing the base and paths to the different image sizes of the primary image |
| base | string | The base will contain the first part of the URL needed to retrieve the specified image. |
| parts | object | This will contain an array of URL parts for the different sizes of images. |
| full | string | The end of the URL to retrieve a full-sized image. |
| large | string | The end of the URL to retrieve a large-sized image. |
| medium | string | The end of the URL to retrieve a medium-sized image. |
| thumb | string | The end of the URL to retrieve a thumb-sized image. |
| record_count | int | The total number of records matching the search results. |
| bid_type_name | string | The name of the processed bid type. |
| bid_amount | double | The amount of the processed bid. |
| timed_bid_amount | double | The limit submitted for the timed bid. |
| phone_bid_amount | double | The amount left as an insurance bid in case the user cannot be reached by phone. |
| bid_info | object | An object containing information about the current bid status. |
| high_bid | double | The current high bid for the item. |
| next_bid | double | The next required bid amount. |
| bid_increment | double | The current bid increment. |
| user | object | Contains an object of user details. |
| can_bid | bool | Specifies whether the user can place a bid for the current item or not. |
| high_bids | object | Contains information for the user's bids on the item. |
| bid_amount | decimal | Contains the highest executed bid left for this item by the user. |
| phone_bid_active | bool | Specifies if the user registered for phone bidding for this item. |
| phone_bid_amount | decimal | Contains the phone bid insurance amount left for this item by the user. |
| timed_bid_amount | decimal | Contains the top bid amount left for timed bidding for this item bye the user. |
| record_count | int | The total number of records. |
To filter, you can specify a any of the following fields in the JSON.
The date should be in the format of YYYY-MM-DD.
The bid_status represents whether the user is the High Bidder (1) or not the high bidder (2). If not specified, it will return results for both.
Below is a list of system bid types.
| System Type ID |
System Type Name |
| 1 | Absentee Bid |
| 2 | Timed Bid |
| 3 | Phone Bid |
| 4 | Floor Bid |
| 5 | Live Online Bid |
| 6 | Buy-It-Now Bid |
| 10 | Other |