/getPackages
Updated
by
Jon Doehling
Get Packages API Call
- Retrieves all package data for a specific event.
Production Endpoint: https://auctionconductor.com/API/getPackages
QA Staging Endpoint: https://actestserver.com/API/getPackages
Accepted Data
Parameter | Req’d | Format | Default | Description |
event_id | Y | number | (none) | unique AES event identifier |
Return Values
Parameter | Format | Description |
package_id | number | Package identifier number |
event_id | number | Event identifier number |
category_name | text | Package category name |
category_id | number | Package category identifier number |
type_name | text | Package type name |
distribution_type_name | string | Must be one of the following:
|
priceless | boolean | If true, will display on bidding site as “Priceless” and will appear as $0 value on patron receipts. Cannot be true if there is a defined package value. |
instant_pay | boolean | Will require instant payment from user when purchased on the mobile bidding site. Only applicable to these types:
|
published_to | string | Must be one of the following:
‘Event’ means silent auction only ‘Online’ means pre-event and post-event auctions (if applicable) |
location | text | If not already created in auction conductor, a new location will be added |
value | number | Fair Market Value. If sent as decimal, will be rounded off to nearest whole number. |
show | boolean | Show fair market value to bidders on the mobile bidding application. Does not impact value on receipts. |
increment | number | Bidding Increment for the package. Only applicable to SILENT auction, all other package types will return a null value. If sent as decimal, will be rounded off to nearest whole number. |
buy_now | number | Bidding Increment for the package. Only applicable to SILENT auction, all other package types will return a null value. If sent as decimal, will be rounded off to nearest whole number. |
quantity_available | number | If the package is Silent, Live, or Fixed Price, quantity should be 1. For all other types, should be greater than 1. |
quantity_unlimited | boolean | Only applicable for these types:
|
minimum_bid | number | Minimum bid for the package. Only applicable to SILENT and LIVE auction. If sent as decimal, will be rounded off to nearest whole number. |
purchase_price | number | Purchase price for the package. Only applicable to multi-unit types:
If sent as decimal, will be rounded off to nearest whole number. |
cost | number | True cost to the organization |
reserve | number | Reserve Amount is the lowest possible amount an item can sell for without losing money when minimum bids are slashed during the auction. Reserve needs to be greater than cost but less than minimum bid. |
admissions_per_package | number | Only used when the package is either 'tickets and admission' or 'sponsorship' type |
tax_rate | decimal | Taxation rate. Maximum of 2 decimal places. |
taxable_percent | number | Percentage of the package that is taxable |
name | text | Package name |
description | text | Detailed package description |
restriction | text | Package restrictions |
show_restrictions | Boolean | Show package restrictions to users on the mobile bidding application |
donor | text | Package donor |
notes | text | Notes about the package, for admin staff use only |
is_sponsored | boolean | Only used when the package is 'tickets and admission' type |
number | number | Number assigned to the pacakge for the event |
created_at | timestamp | Date and time when the package was originally created. |
is_vip | boolean | Indicates if the purchaser should be marked as a VIP contributor. Only applies to Sponsorship and Tickets and Admission Types, all other types will return false. |
edited_at | timestamp | Date and time when the package was last edited. |
edited_by | text | Username or "API" when the package was last edited. |
Sample Call
{
event_id: 2374
}Sample Return Values
{
"package_id": 14049,
"event_id": 2374,
"category_name": "Wines",
"category_id": 2621,
"type_name": "Multi-Unit",
"distribution_type_name": "Physical",
"priceless": false, "instant_pay": false,
"published_to": "ALL",
"location": "",
"value": 1000,
"show": true,
"increment": 0,
"buy_now": null,
"quantity_available": null,
"quantity_unlimited": true,
"minimum_bid": null,
"purchase_price": 100,
"cost": null,
"reserve": null,
"admissions_per_package": null,
"tax_rate": 3.75,
"taxable_percent": 100,
"name": "Silent Pkg 3",
"description": "Cater your next party with $500 of East Coast deliciousness from Mojo's East Coast Eats located in Downers Grove. Voted \"Chicago's Best Cheesesteak\" by WGN in 2015, Mojo's serves a variety of authentic cheesesteaks, hoagies, and salads. ",
"restriction": "Expires 07/16/2017. Does not include delivery. See catering menu for a selection of items.",
"show_restrictions": true,
"donor": null,
"notes": null,
"is_sponsored": false,
"number": 3001,
"created_at": "/Date(1521681572480)/",
"is_vip": false,
"edited_at": "/Date(1599694235367)/",
"edited_by": "John Smith"
},
{
"package_id": 14050,
"event_id": 2374,
"category_name": "Automotive",
"category_id": 2625,
"type_name": "Silent",
"distribution_type_name": "Certificate",
"priceless": false,
"instant_pay": false,
"published_to": "ALL",
"location": "",
"value": 100,
"show": true,
"increment": 10,
"buy_now": 150,
"quantity_available": 1,
"quantity_unlimited": false,
"minimum_bid": 100,
"purchase_price": null,
"cost": null,
"reserve": null,
"admissions_per_package": null,
"tax_rate": 0,
"taxable_percent": 0,
"name": "Item 1",
"description": null,
"restriction": null,
"show_restrictions": false,
"donor": null,
"notes": null,
"is_sponsored": false,
"number": 7001,
"created_at": "/Date(1521681727027)/",
"is_vip": false,
"edited_at": "/Date(1602628763953)/",
"edited_by": "John Smith"
}
