/createPackageCategory

Updated by Jon Doehling

Create Package Category API Call

  • Creates a new package category in AES database and returns a unique id to identify created record.

Production Endpoint: https://auctionconductor.com/API/createPackageCategory

Test Endpoint: https://actestserver.com/API/createPackageCategory

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

minimum_percent

N

number

(none)

Default % of value to be applied to new packages, determines the minimum bid

increment_percent

N

number

(none)

Default % of value to be applied to new packages, determines the incremental raise per bid

buy_now_percent

N

number

(none)

Default % of value to be applied to new packages, determines the Buy Now Price.

start_number

N

number

(none)

Starting package number for the category. If none is given, the next available range of numbers in either the 100's or 1000's (depending on event settings) will be automatically generated.

end_number

N

number

(none)

Ending package number for the category. If none is given, the next available range of numbers in either the 100's or 1000's (depending on event settings) will be automatically generated.

 Return Values 

Parameter

Value

Description

package_category_id

number

Unique id that identifies created record. This number can be used for later calls such as updatePackageCategory, deletePackageCategory, etc.

Sample Call

{
event_id: 2442,
category_name: "Electronics",
minimum_percent: 40,
increment_percent: 10,
buy_now_percent: 150
}

Sample Response

{
"package_category_id": 2748
}


How did we do?