/createPackage
Updated
by
Jon Doehling
Create Package API Call
- Creates a new package in AES database and returns a unique id and package number to identify created record.
Production Endpoint: https://auctionconductor.com/API/createPackage
Test Endpoint: https://actestserver.com/API/createPackage
Accepted Data
Parameter | Req’d | Format | Default | Description |
event_id | Y | number | (none) | Event identifier number |
category_name | Y | 50 chars | (none) | Package category name |
type_name | Y | string | (none) | Must be one of the following:
|
distribution_type_name | Y | string | (none) | Must be one of the following:
|
priceless | N | boolean | False | 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 | N | boolean | False | Will require instant payment from user when purchased on the mobile bidding site. Only applicable to these types:
|
published_to | Y | string | (none) | Must be one of the following:
‘Event’ means silent auction only ‘Online’ means pre-event and post-event auctions (if applicable) |
location | N | 50 chars | (none) | If not already created in auction conductor, a new location will be added |
quantity_available | Y, if UNLIMITED is false | number | (none) | If the package is Silent, Live, or Fixed Price, quantity should be 1. For all other types, should be greater than 1. |
quantity_unlimited | N | boolean | False | Only applicable for these types:
|
value | Y, if PRICELESS is false | number | (none) | Fair Market Value. If sent as decimal, will be rounded off to nearest whole number. |
show | N | boolean | False | Show fair market value to bidders on the mobile bidding application. Does not impact value on receipts. |
minimum_bid | Y, if type_name is SILENT or LIVE | number | (none) | 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 | Y, if type_name is SILENT | number | (none) | Bidding Increment for the package. Only applicable to SILENT auction. If sent as decimal, will be rounded off to nearest whole number. |
buy_now | N | number | (none) | Bidding Increment for the package. Only applicable to SILENT auction. If sent as decimal, will be rounded off to nearest whole number. |
purchase_price | Y, if type_name IS NOT SILENT OR LIVE | number | (none) | Purchase price for the package. Only applicable to multi-unit types:
If sent as decimal, will be rounded off to nearest whole number. |
cost | N | number | (none) | True cost to the organization |
reserve | N | number | (none) | 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 | N | decimal | (none) | Taxation rate. Maximum of 2 decimal places. |
taxable_percent | N | number | (none) | Percentage of the package that is taxable |
name | Y | 60 chars | (none) | Package name |
description | Y | 900 chars | (none) | Detailed package description |
restriction | N | 900 chars | (none) | Package restrictions |
show_restrictions | N | Boolean | False | Show package restrictions to users on the mobile bidding application |
donor | N | 80 chars | (none) | Package donor |
admissions_per_package | Y if 'Tickets and Admission' type | Boolean | (none) | Only available when the package is either 'tickets and admission' (req'd) or 'sponsorship' (optional) type |
is_sponsored | N | Boolean | False | Only available when the package is 'tickets and admission' type. |
coupon_code | N | text | (none) | Optional, only available when the package is these types:
|
coupon_discount | Y when coupon_code exists | number | (none) | Amount to discount the package when a valid coupon code is detected at checkout. Required only when coupon_code is present. Must be less than or equal to package price. |
Return Values
Parameter | Value | Description |
package_id | number | Unique id that identifies created record. This number can be used for later calls such as updatePackage, deletePackage, etc. |
package_number | number | Assigned package number |
Sample Call
{
event_id: 2442,
category_name: "home and garden",
type_name: "silent",
distribution_type_name: "certificate",
priceless: "true",
published_to: "all",
quantity_available: 1,
show: "true",
increment: 50,
minimum_bid: 500,
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"
}
Sample Response
{
"package_id": 14322,
"package_number": 700
}
