---
title: "/getPackage"
description: "Get Package API Call. Retrieves data for a specific package. Production Endpoint: https://auctionconductor.com/API/getPackage QA Staging Endpoint: https://ac testserver.com/API/ getPackage Accepted D…"
url: "https://help.aesauctions.com/article/0moxn3lv16-get-package"
category: "API"
updated_at: "2025-02-13T19:17:12Z"
---

# /getPackage

### 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**

\* indicates data will always be returned

Parameter

Format

Description

event\_id*

number

Event identifier number

category\_name*

text

Package category name

type\_name*

string

Must be one of the following:

- Live
- Silent
- Fixed Price
- Multi-Unit
- Donation
- Tickets and Admission
- Sponsorship
- Registration Extras

distribution\_type\_name*

string

Must be one of the following:

- Certificate
- Physical
- Both
- Certificate and Physical
- N/A

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:

- Fixed Price
- Multi-Unit
- Donation
- Tickets and Admission
- Sponsorship
- Registration Extras

published\_to*

string

Must be one of the following:

- Event
- Online
- All
- None

‘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:

- Multi-Unit
- Donation
- Tickets and Admission
- Sponsorship
- Registration Extras

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:

- Multi-unit
- Sponsorship
- Donation
- Fixed Price
- Tickets and Admission
- Registration Extras

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

- tickets and admission
- sponsorship
- multi-unit
- registration extras
- fixed price

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": ""
}
```