--- title: "/updatePackage" description: "Update Package API Call. Updates an existing package in AES database and returns a unique id and package number to identify updated record. Production Endpoint: https://auctionconductor.com/API/updat…" url: "https://help.aesauctions.com/article/0roqblyzjm-update-package" category: "API" updated_at: "2024-04-26T20:04:10Z" --- # /updatePackage ### Update Package API Call - Updates an existing package in AES database and returns a unique id and package number to identify updated record. **Production Endpoint: https://auctionconductor.com/API/updatePackage** **QA Staging Endpoint: https://actestserver.com/API/updatePackage** #### Accepted Data Parameter Req’d Format Default Description package\_id Y number (none) Event identifier number 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: - Live - Silent - Fixed Price - Multi-Unit - Donation - Tickets and Admission - Sponsorship - Registration Extras distribution\_type\_name Y string (none) Must be one of the following: - Certificate - Physical - Both - Certificate and Physical - N/A 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: - Fixed Price - Multi-Unit - Donation - Tickets and Admission - Sponsorship - Registration Extras published\_to Y string (none) 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 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: - Multi-Unit - Donation - Tickets and Admission - Sponsorship - Registration Extras 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: - Multi-unit - Sponsorship - Donation - Fixed Price - Tickets and Admission - Registration Extras 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: - tickets and admission - sponsorship - multi-unit - registration extras - fixed price 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 ``` { package_id: 14322, event_id: 2442, category_name: "home and garden", type_name: "silent", distribution_type_name: "physical", 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 } ```