--- title: "/getSales" description: "Get Sales API Call. Returns all currently finalized sales for a particular event. Includes all donations, multi-unit purchases, and winning bids for closed auction categories. Does not include winnin…" url: "https://help.aesauctions.com/article/uwwu83bw7m-get-sales" category: "API" updated_at: "2025-02-13T19:45:10Z" --- # /getSales ### Get Sales API Call - Returns all currently finalized sales for a particular event. Includes all donations, multi-unit purchases, and winning bids for closed auction categories. - Does not include winning bids for packages within categories which are still open for bidding. **Production Endpoint: https://auctionconductor.com/API/getSales** **QA Staging Endpoint: https://actestserver.com/API/getSales** #### Accepted Data | Parameter | Required | Format | Default | Description | |-----------|----------|--------|---------|---------------------------------------------------------------------------------------------| | event\_id | yes | number | (none) | Unique identifier for the event. Organization assigned to the event must match the API key. | #### **Return Values** \* indicates data will always be returned Parameter Format Description Example event\_id* number Unique identifier for the event. 2244 event\_contributor\_id* number Unique identifier for the contributor in relation to the event. 61637 bidder\_number* number Possibly shared, possibly dynamic number assigned to the eventcontributor. Essentially a username in number format. 100 package\_id* number Unique identifier for the package. 7607 package\_category\_id* number Unique identifier for the category where the package is assigned. 2247 package\_number* number Friendly identifyer for the package, not unique across events. 1 category\_name* text Friendly name for the category where the package is assigned. Home and Garden quantity* number For silent and live auction, will always equal 1. For multi-unit packages may be greater than 1. 3 purchase\_amount* decimal Currency in U.S. dollars and cents only. This is either a: - Winning bid amount for a silent auction package, live auction package, or general donation - Subtotal (purchase price * qty) for a multi-unit or donation package 125.00 tax\_amount decimal Currency in U.S. dollars and cents only. Total amount of tax assesed for this sale. 3.16 total\_amount* decimal Currency in U.S. dollars and cents only. Grand total (tax + purchase) for this sale. 128.16 purchase\_id* text Unique identifier for the sale. Is a concatenation of the type of sale plus the nonunique identifyer for the sale. - MUXXXXX = Multi-Unit purchase - DONXXXXX = General donation - BIDXXXXX = Winning bid BID12345 date* timestamp Date and time of the bid, doantion, or multi-unit purchase. /Date(1521861353627)/ entered\_by* text Possible responses include: - Logged user (fname lname) - Device ID for a community kiosk (AES 1234) - "Personal Device" if bid/purchased from the users mobile device - "Ticketing App" if purchased from the event microsite Personal Device #### Sample Call ``` { event_id: "2442" } ``` #### Sample Response ``` [ { "event_id": 2442, "event_contributor_id": 62890, "bidder_number": 114, "package_id": 14320, "package_category_id": 2689, "package_number": 1, "category_name": "Live Auction", "quantity": 1, "purchase_amount": 66, "tax_amount": 0, "total_amount": 66, "purchase_id": "BID459205", "date": "/Date(1559936090807)/", "entered_by": "" }, { "event_id": 2442, "event_contributor_id": 62861, "bidder_number": 123, "package_id": 14160, "package_category_id": 2690, "package_number": 100, "category_name": "Silent1", "quantity": 1, "purchase_amount": 400, "tax_amount": 0, "total_amount": 400, "purchase_id": "BID459175", "date": "/Date(1556829338053)/", "entered_by": "Non-AES Device" }, { "event_id": 2442, "event_contributor_id": 63312, "bidder_number": 103, "package_id": 14161, "package_category_id": 2690, "package_number": 101, "category_name": "Silent1", "quantity": 1, "purchase_amount": 100, "tax_amount": 0, "total_amount": 100, "purchase_id": "BID459153", "date": "/Date(1556808104837)/", "entered_by": "Non-AES Device" }, { "event_id": 2442, "event_contributor_id": 63310, "bidder_number": 102, "package_id": 14162, "package_category_id": 2691, "package_number": 200, "category_name": "Silent2", "quantity": 1, "purchase_amount": 60, "tax_amount": 0, "total_amount": 60, "purchase_id": "BID459125", "date": "/Date(1556679898770)/", "entered_by": "Non-AES Device" }, { "event_id": 2442, "event_contributor_id": 63310, "bidder_number": 102, "package_id": 14163, "package_category_id": 2691, "package_number": 201, "category_name": "Silent2", "quantity": 1, "purchase_amount": 60, "tax_amount": 0, "total_amount": 60, "purchase_id": "BID459126", "date": "/Date(1556679934240)/", "entered_by": "Non-AES Device" }, { "event_id": 2442, "event_contributor_id": 62861, "bidder_number": 123, "package_id": 14167, "package_category_id": 2690, "package_number": 105, "category_name": "Silent1", "quantity": 1, "purchase_amount": 131, "tax_amount": 0, "total_amount": 131, "purchase_id": "BID459177", "date": "/Date(1556839207253)/", "entered_by": "Non-AES Device" }, { "event_id": 2442, "event_contributor_id": 62861, "bidder_number": 123, "package_id": 14164, "package_category_id": 2728, "package_number": 400, "category_name": "Donations", "quantity": 1, "purchase_amount": 100, "tax_amount": 0, "total_amount": 100, "purchase_id": "MU52610", "date": "/Date(1539888903847)/", "entered_by": "" }, { "event_id": 2442, "event_contributor_id": 62862, "bidder_number": 222, "package_id": 14164, "package_category_id": 2728, "package_number": 400, "category_name": "Donations", "quantity": 1, "purchase_amount": 100, "tax_amount": 0, "total_amount": 100, "purchase_id": "MU52611", "date": "/Date(1539888905050)/", "entered_by": "" }, { "event_id": 2442, "event_contributor_id": 62856, "bidder_number": 101, "package_id": 14164, "package_category_id": 2728, "package_number": 400, "category_name": "Donations", "quantity": 1, "purchase_amount": 100, "tax_amount": 0, "total_amount": 100, "purchase_id": "MU52612", "date": "/Date(1539888906503)/", "entered_by": "" }, { "event_id": 2442, "event_contributor_id": 62863, "bidder_number": 111, "package_id": 14165, "package_category_id": 2728, "package_number": 401, "category_name": "Donations", "quantity": 1, "purchase_amount": 250, "tax_amount": 0, "total_amount": 250, "purchase_id": "MU52613", "date": "/Date(1539888910537)/", "entered_by": "" }, { "event_id": 2442, "event_contributor_id": 62856, "bidder_number": 101, "package_id": 14166, "package_category_id": 2727, "package_number": 300, "category_name": "Multi-Unit", "quantity": 2, "purchase_amount": 200, "tax_amount": 0, "total_amount": 200, "purchase_id": "MU52615", "date": "/Date(1539907310210)/", "entered_by": "" }, ], ```