/getPackage
Updated
by
Jon Doehling
Get Package API Call
- Retrieves data for a specific package.
Production Endpoint: https://auctionconductor.com/API/getPackage
QA Staging Endpoint: https://actestserver.com/API/getPackage
Accepted Data
Parameter | Req’d | Format | Default | Description |
package_id | Y | number | (none) | Package identifier returned by the createPackage call. |
Return Values
Parameter | Format | Description |
event_id | number | Event identifier number |
category_name | text | Package category name |
type_name | string | Must be one of the following:
|
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 |
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:
|
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. |
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. |
increment | number | Bidding Increment for the package. Only applicable to SILENT auction. 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. 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. |
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 |
admissions_per_package | number | Only used when the package is either 'tickets and admission' or 'sponsorship' type |
is_sponsored | boolean | Only used when the package is 'tickets and admission' type |
number | number | Number assigned to the pacakge for the event |
coupon_code | text | Optional, only available when the package is these types
|
coupon_discount | number | Required only when coupon_code is present |
created_at | timestamp | Date and time when the package was originally created. |
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
{
package_id: 14322
}Sample Return Values
{
"package_id": 14322,
"event_id": 2442,
"category_name": "Home and Garden",
"category_id": 2747,
"type_name": "Silent",
"distribution_type_name": "Physical",
"priceless": true,
"instant_pay": false,
"published_to": "ALL",
"location": "",
"value": null,
"show": true,
"increment": 50,
"buy_now": null,
"quantity_available": 1,
"quantity_unlimited": false,
"minimum_bid": 500,
"purchase_price": null,
"cost": null,
"reserve": null,
"tax_rate": null,
"taxable_percent": null,
"name": "Silent Auction Package #1",
"description": "This is the description of silent auction package #1.",
"restriction": "Must be redeemed in person",
"show_restrictions": false,
"donor": "Jon Doe",
"notes": null,
"admissions_per_package": null,
"is_sponsored": false,
"number": 700,
"coupon_code": null,
"coupon_discount": null,
"created_at": "/Date(1561163345503)/",
"edited_at": "/Date(1561163841767)/",
"edited_by": ""
}
