# Auction Plus Help Center
Get the most out of Auction Plus with our official documentation. Here, you’ll find clear instructions on setting up Auction Plus on your storefront, launching competitive auctions and offer campaigns, and managing the entire customer experience.
Auction Plus adds three core experiences to your Shopify store:
* **Auctions** for timed bidding
* **Make an Offer** for negotiated pricing
* **Watchlists** so customers can follow and share products
If you are setting up the app for the first time, start with the setup guides below. If you already have Auction Plus live, jump to the feature area or troubleshooting section you need.
## Start Here
If you are new to Auction Plus, begin with these guides:
* [Get Started with Auction Plus](/start-here/get-started-with-auction-plus) — Overview of Auctions, Make an Offer, and Watchlists
* [Setup Wizard](/start-here/setup-wizard) — Guided setup for core features
* [Theme Setup](/storefront-setup/theme-setup) — Enable the app in your Shopify theme
* [How Checkout Works](/products-and-checkout/get-started-with-orders-and-checkout) — Understand the customer checkout flow
## Most Common Tasks
* [Creating an Auction](/auctions/creating-an-auction) — Create and launch your first auction
* [Managing Auctions](/auctions/managing-auctions) — Manage and review auction activity
* [Offer Rules](/offers/offer-rules) — Control when customers can submit offers
* [Declaring and Managing Winners](/auctions/managing-winners-and-second-chance-offers) — Finalize auction results and next steps
* [Payment Reminders](/customers-and-bidders/payment-reminders) — Automatically prompt customers to complete payment
## Browse by Feature
### Auctions
* [Getting Started with Auctions](/auctions/getting-started-with-auctions)
* [Auction Listing Settings](/auctions/auction-listing-settings)
* [Default Auction Settings](/auctions/default-auction-settings)
* [Bulk Editing Auctions](/auctions/bulk-editing-auctions)
### Offers
* [Get Started with Offers](/offers/get-started-with-offers)
* [Managing Offers](/offers/managing-offers)
* [Adding the Offer Button](/storefront-setup/adding-offer-button)
### Watchlists
* [Getting Started with Watchlists](/following/getting-started-with-watchlists)
* [Adding the Follow Button](/storefront-setup/adding-follow-button)
### Products and checkout
* [Product Fees](/products-and-checkout/product-fees-and-buyers-premium)
* [Restricting Purchases for Auction Products](/products-and-checkout/restricting-purchases-for-auction-products)
* [How Checkout Works](/products-and-checkout/get-started-with-orders-and-checkout)
### Customers and bidders
* [Managing Customers](/customers-and-bidders/managing-customers)
* [Bidder Registration and Approval](/customers-and-bidders/bidder-registration-and-approval)
* [Adding an Auctions Link to Customer Accounts](/customers-and-bidders/adding-an-auctions-link-to-customer-accounts)
## Troubleshooting
Start here if something is not working as expected:
* [Common Issues](/troubleshooting/common-issues)
* [FAQ](/troubleshooting/faq)
## Need Help?
Email `support@auctionplusapp.com` or open the in-app chat from your Auction Plus dashboard.
# Full Help Center Index
Use these guides to set up Auction Plus, launch auctions, manage offers, and help customers complete checkout.
## Start Here
If you're new to Auction Plus, begin with these pages:
* [Get Started with Auction Plus](/start-here/get-started-with-auction-plus)
* [Setup Wizard](/start-here/setup-wizard)
* [Customer Accounts](/start-here/customer-accounts)
* [Dashboard Overview](/start-here/dashboard-overview)
## Storefront Setup
Use these guides when you are connecting Auction Plus to your Shopify theme:
* [Theme Setup](/storefront-setup/theme-setup)
* [Adding the Auction Block](/storefront-setup/adding-auction-block)
* [Adding the Offer Button](/storefront-setup/adding-offer-button)
* [Adding the Follow Button](/storefront-setup/adding-follow-button)
* [Creating an Auctions Page](/storefront-setup/auctions-page)
* [Creating an Ending Soon Collection](/storefront-setup/ending-soon-collection)
## Auctions
* [Getting Started with Auctions](/auctions/getting-started-with-auctions)
* [Creating an Auction](/auctions/creating-an-auction)
* [Managing Auctions](/auctions/managing-auctions)
* [Auction Listing Settings](/auctions/auction-listing-settings)
* [Default Auction Settings](/auctions/default-auction-settings)
* [Global Auction Settings](/auctions/global-auction-settings)
* [Auction Events](broken://pages/1QAwJm5tmpOyrrzjN6tX)
* [Declaring and Managing Winners](/auctions/managing-winners-and-second-chance-offers)
* [Relisting Auctions](/auctions/relisting-auctions)
* [Bulk Editing Auctions](/auctions/bulk-editing-auctions)
* [CSV Import Guide](/auctions/csv-import-export-guide)
* [CSV Column Reference](/auctions/csv-column-reference)
* [Collection Bidding](/auctions/collection-bidding)
## Offers
* [Get Started with Offers](/offers/get-started-with-offers)
* [Managing Offers](/offers/managing-offers)
* [Offer Rules](/offers/offer-rules)
## Following
* [Getting Started with Watchlists](/following/getting-started-with-watchlists)
## Products and Checkout
* [Product Fees](/products-and-checkout/product-fees-and-buyers-premium)
* [Removing Auctions from the Storefront](/products-and-checkout/removing-auctions-from-storefront)
* [Restricting Purchases for Auction Products](/products-and-checkout/restricting-purchases-for-auction-products)
* [How Checkout Works](/products-and-checkout/get-started-with-orders-and-checkout)
## Customers and Bidders
* [Managing Customers](/customers-and-bidders/managing-customers)
* [Banning Customers](/customers-and-bidders/banning-customers)
* [Bulk Customer Actions](/customers-and-bidders/bulk-customer-actions)
* [Adding an Auctions Link to Customer Accounts](/customers-and-bidders/adding-an-auctions-link-to-customer-accounts)
* [Bidder Registration and Approval](/customers-and-bidders/bidder-registration-and-approval)
* [Payment Reminders](/customers-and-bidders/payment-reminders)
## Email and Notifications
* [Notification Types](/email-and-notifications/notification-types)
* [Customizing Email Templates](/email-and-notifications/customizing-email-templates)
* [Uploading Your Logo](/email-and-notifications/uploading-your-logo)
* [Admin Email Notifications](/email-and-notifications/admin-email-notifications)
* [Custom Sender Domain](/email-and-notifications/custom-sender-email-domain)
## Integrations
* [Klaviyo Integration](/integrations/klaviyo)
* [Klaviyo Event Reference](/integrations/klaviyo-events)
## Analytics
* [Analytics Dashboard](/analytics/analytics-dashboard)
## Plans and Billing
* [Plans and Billing](/plans-and-billing/plans)
## Translations
* [Multi-Language Support](/translations/multi-language-support)
## Troubleshooting
* [Common Issues](/troubleshooting/common-issues)
* [FAQ](/troubleshooting/faq)
## Need Help?
Email `support@auctionplusapp.com` or open the in-app chat from your Auction Plus dashboard.
# Get Started with Auction Plus
This guide helps you set up Auction Plus before you launch. Follow the steps below to enable the desired settings, choose the features would like to integrate, and review the customer experience on your live theme.
## Recommended setup order
{% stepper %}
{% step %}
### Enable your storefront app embed
Start by enabling Auction Plus in your live theme. This powers auctions, offers, follow buttons, and other storefront features.
See [Theme Setup](/storefront-setup/theme-setup).
{% endstep %}
{% step %}
### Follow the setup wizard
The setup wizard walks you through the main storefront steps for each feature and helps you avoid missing required setup.
See [Setup Wizard](/start-here/setup-wizard).
{% endstep %}
{% step %}
### Set up the features you plan to use
Each feature can be setup independently
* For timed auctions, see [Getting Started with Auctions](/auctions/getting-started-with-auctions)
* To enable negotiated pricing with Make an Offer, see [Get Started with Offers](/offers/get-started-with-offers)
* To activate watchlists/wishlists, see [Getting Started with Watchlists](/following/getting-started-with-watchlists)
{% endstep %}
{% step %}
### Test the customer flow before launch
Before you share or advertise your campaign, confirm that app feature appear on the product and collection pages. If you need assistance with final touches, reach out to our support team via the in-app chat or contact `support@auctionplusapp.com`
Review [How Checkout Works](/products-and-checkout/get-started-with-orders-and-checkout) and keep [Common Issues](/troubleshooting/common-issues) handy for troubleshooting.
{% endstep %}
{% endstepper %}
## Before you go live
Confirm these items:
1. The app embed is enabled on your live theme
2. The correct app blocks or buttons are added to the right templates
3. You have tested the product page experience on your storefront
4. You have allocated inventory to your auction or offer products
{% hint style="info" %}
If a feature does not appear on your storefront, check [Theme Setup](/storefront-setup/theme-setup) and [Common Issues](/troubleshooting/common-issues).
{% endhint %}
## Helpful next steps
After setup, consider reviewing:
* [Dashboard Overview](/start-here/dashboard-overview)
* [Customer Accounts](/start-here/customer-accounts)
* [Plans and Billing](/plans-and-billing/plans)
## Need Help?
Email `support@auctionplusapp.com` or reach out via the in-app chat.
# Setup Wizard
The **App Setup** section on the dashboard in Auction Plus is your guided setup area. Each guide will walk you through the core steps to get each feature up and running on your storefront.
## What You Will See
The page is organized into three feature cards:
1. **Auctions**
2. **Make an Offer**
3. **Following**
Each card has a **Get Started** button if the feature is not fully configured yet.
## Auction Setup Flow
The Auctions setup flow walks you through these core steps:
1. Create an auction
2. Activate the storefront theme
3. Create an auctions page
4. Preview the auction
After setup, the **Features > Auctions** area also gives you separate steps for adding the auction app block to your product template and for creating an auction collection.
## Make an Offer Setup Flow
The Make an Offer setup flow walks merchants through:
1. Activating the storefront theme
2. Customizing the chat appearance
3. Creating an offer rule
4. Adding the Make Offer button
## Following Setup Flow
The Following setup flow focuses on storefront placement for your watchlists:
1. Activate the storefront theme
2. Add the Follow button to product pages
3. Add the Following page button to your store header
## When to Use the Wizard
Use the wizard if you are:
* Setting up a feature for the first time
* Unsure which storefront step comes next
## Skipping the Wizard
If you skip the wizard, you can return to the **Features** page at any time to complete setup for a feature.
## Related Pages
* [Theme Setup](/storefront-setup/theme-setup)
* [Getting Started with Auctions](/auctions/getting-started-with-auctions)
* [Get Started with Offers](/offers/get-started-with-offers)
* [Getting Started with Watchlists](/following/getting-started-with-watchlists)
# Customer Accounts
Auction Plus requires Shopify customer accounts for bidding and for customers to complete payment on won or accepted items.
***
## New Customer Accounts (Default Since July 2024)
Shopify's new customer accounts use one-time email codes instead of passwords. If your store uses new customer accounts, add a link to the Ready for Checkout page in the customer account navigation so auction winners can easily find their won items.
See [Adding an Auctions Link to Customer Accounts](/customers-and-bidders/adding-an-auctions-link-to-customer-accounts) for step-by-step instructions.
***
## Legacy Customer Accounts
With legacy accounts (email + password login), the Ready for Checkout page is automatically added to the customer account navigation.
# Dashboard Overview
The dashboard is your central hub for managing your auctions, offers, and customers. It provides a high-level overview of your store's activity and quick access to key actions.
## Theme Actions
At the top of the dashboard, you will see quick buttons for:
* **App Embed**
* **App Blocks**
These buttons show you the status of your app embed and blocks on your live theme, which are required for app features to appear on your storefront.
## Quick Search
The dashboard includes a universal search card that lets you quickly find app content and pages without navigating through menus. Start typing in the search field to see matching results appear instantly.
You can filter your search across:
* **Navigation** — jump directly to a page in the app
* **Products** — find products by title
* **Customers** — look up customers by name or email
* **Events** — locate auction events by name
Use the arrow keys to move between results and press **Enter** to open the highlighted item. Navigation results take you straight to the matching page, while product, customer, and event results link into their respective detail pages.
## Key Details
The dashboard includes three main summary areas:
### Customers
This section highlights:
* Customer count
* Product follows
It also links to the recent Following activity page.
### Auctions
This section highlights:
* Live auctions
* Scheduled auctions
* Unpaid auctions
Use these numbers to jump into the filtered auction list you need.
### Orders
This section highlights:
* Paid auction orders
* Unfulfilled orders
Use it to stay on top of fulfillment after auctions end.
## Gross Sales
The dashboard includes a **Last 30 Days** gross sales card. Press the **View Analytics** button to open the full analytics page for additional sales data and insights.
## Recent Events
If you run auction events, the dashboard shows a recent events card so you can jump straight into event management.
## Documentation and Support
Near the bottom of the dashboard you will find:
* Documentation links
* Video tutorials
* Chat or email support
## Related Pages
* [Setup Wizard](/start-here/setup-wizard)
* [Customer Accounts](/start-here/customer-accounts)
* [Analytics Dashboard](/analytics/analytics-dashboard)
# Theme Setup
Auction Plus needs two theme pieces to work correctly on your storefront:
1. The **app embed** must be enabled.
2. The right **app blocks** must be added where you want auctions, offers, or the following button to appear.
## What the App Embed Does
The app embed powers the shared storefront features used across Auction Plus, including:
* Auction bidding on product pages
* Countdown displays on collection pages
* The Make an Offer experience
* Watchlist & wishlist features
If the app embed is off, merchants can still configure settings in Auction Plus, but customers will not see those features on the storefront.
## Turn On the App Embed
You can open the Shopify theme editor from several places in Auction Plus:
* The **App Embed** button on the dashboard
* From the **Settings > Theme** page
* The **Features** setup flow for Auctions, Make an Offer, or Following
## When to Add App Blocks
After the app embed is active, add the specific app blocks you need:
* [Adding the Auction Block](/storefront-setup/adding-auction-block)
* [Adding the Offer Button](/storefront-setup/adding-offer-button)
* [Adding the Follow Button](/storefront-setup/adding-follow-button)
These blocks are added inside your Shopify theme editor and control where each feature appears.
## Theme Compatibility Notes
Some themes support app blocks on product pages and in the header. Others need light theme adjustments.
If a guide tells you your theme does not support a required app block location, contact `support@auctionplusapp.com` or use the in-app chat and we can help with theme-specific setup.
## Related Pages
* [Adding the Auction Block](/storefront-setup/adding-auction-block)
* [Adding the Offer Button](/storefront-setup/adding-offer-button)
* [Adding the Follow Button](/storefront-setup/adding-follow-button)
* [Creating an Auctions Page](/storefront-setup/auctions-page)
* [Creating an Ending Soon Collection](/storefront-setup/ending-soon-collection)
# Adding the Auction Block
Use the Auction app block to show bidding on your product page.
## Before You Start
Make sure:
* The [app embed is enabled](/storefront-setup/theme-setup)
* You have created at least one auction
* You know which Shopify product template you want to use for auction items
## Recommended Setup Path
In Auction Plus, open **Features > Auctions**. The guided setup walks you through:
1. Creating an auction
2. Activating auctions on your theme
3. Creating a collection for live auctions
4. Previewing the storefront
5. Adding the Auction app block
## Add the Block
There are two ways to add the Auction app block to your product pages:
* Use the guided setup flow (recommended)
* Once the auction setup is complete, the **Features** page will show a checklist of available guides, including adding the Auction block to your product template
* Manually via the Shopify theme editor
* Open the Shopify theme editor and add the Auction block to your chosen product template
## Product Templates
Auction Plus lets you use a dedicated product template for auction listings. This is the best option if you want auction items to look different from standard products.
If you do not already have a template for auctions:
1. Create a new product template in Shopify's theme editor
2. Add the Auction app block to that template.
3. Set that template as the default auction template from **Settings > Auctions > Product Template**
> Existing auction listings will not be affected by changing the default auction template. You can update the product template for a product by navigating to the Products section in the Shopify admin. The option will appear under the "Theme template" card.
## If Your Theme Does Not Support Product App Blocks
Auction Plus will attempt to display auctions automatically, but some themes need manual adjustments for best results.
If the setup flow warns that your theme does not support product app blocks, contact `support@auctionplusapp.com` or use the in-app chat for help.
## Related Pages
* [Theme Setup](/storefront-setup/theme-setup)
* [Getting Started with Auctions](/auctions/getting-started-with-auctions)
* [Creating an Auction](/auctions/creating-an-auction)
# Adding the Offer Button
Use the Make Offer button to let customers start a negotiation from eligible product pages.
## Before You Start
Make sure:
* The [app embed is enabled](/storefront-setup/theme-setup)
* You have at least one active [offer rule](/offers/offer-rules)
* Your rule applies to the products where you want the button to appear
## Add the Button
1. In Auction Plus, open **Features > Make an Offer**.
2. Open the step for adding the Make Offer button.
3. Launch the Shopify theme editor.
4. Add the **Make Offer** app block to your product page.
5. Save your changes in Shopify.
## Where the Button Appears
The Make Offer button can appear on:
* Product pages that match an active offer rule
* Auction listings before the first bid is placed
If no products match your latest rule, the theme editor may not preview the button until you update the rule or choose a matching product.
> In some cases, the button may not appear in the theme editor preview even if it is correctly set up. If that happens, save your changes and preview the product page directly from your storefront.
## If Your Theme Does Not Support Product App Blocks
Some themes do not expose product app block areas in the theme editor. If that happens, Auction Plus may show a code snippet in the setup flow and you can contact support for help placing it correctly.
Use `support@auctionplusapp.com` or the in-app chat if you need assistance.
## Related Pages
* [Theme Setup](/storefront-setup/theme-setup)
* [Get Started with Offers](/offers/get-started-with-offers)
* [Offer Rules](/offers/offer-rules)
# Adding the Follow Button
Use the Follow button to let customers save products and auction listings to their Following page.
## Before You Start
Make sure:
* The [app embed is enabled](/storefront-setup/theme-setup)
* Following is enabled in **Settings > Following**
* Your current plan includes the Following feature
## Add the Button
1. In Auction Plus, open **Features > Following**.
2. Open the step for adding the Follow button.
3. Launch the Shopify theme editor.
4. Add the **Follow** app block to your product page.
5. Save your changes in Shopify.
## What Customers Can Do
Once the Follow button is live, customers can:
* Save products to their default list
* Create and manage custom lists
* Share their saved items from the Following page
## If Your Theme Does Not Support Product App Blocks
Some themes do not support product app blocks in the expected location. If that happens, Auction Plus may provide a code snippet to place in your product template manually.
If you need help, contact `support@auctionplusapp.com` or open the in-app chat.
## Related Pages
* [Theme Setup](/storefront-setup/theme-setup)
* [Getting Started with Watchlists](/following/getting-started-with-watchlists)
# Creating an Auctions Page
Auction Plus can create a dedicated **Auctions page** on your storefront so customers can browse your auction products in one place. The page is created in Shopify (for example, `/pages/auctions`) and displays your auctions using the **Auction List** block.
## What the Auctions Page Does
The Auctions page gives your store a single destination that lists your auction products. You can:
* Link to it from your store navigation
* Use it as the destination for auction marketing emails or social posts
* Let customers discover, follow, and bid on auctions from one page
## Create the Page
1. In Auction Plus, open **Features > Auctions** (or follow the [Setup Wizard](/start-here/setup-wizard)).
2. Open the **Create auctions page** step.
3. Enter a **Title** and a **URL Handle** for the page. These default to `Auctions` and `pages/auctions`.
4. Click **Create page**.
> **Note:** If a page with the same handle already exists in Shopify, Auction Plus links to it instead of creating a duplicate.
Once created, the page shows as **live** with its storefront URL and a **View in your store** button.
## Add the Auction List Block
After the page is created, add the **Auction List** block so your auctions appear on it:
1. Click **Add Auction List Block** to open the Shopify theme editor on your new page.
2. Add the **Auction List** block, then **Save** in the theme editor.
3. Return to Auction Plus — the step confirms once the block is detected.
> **Note:** The page will look empty until the Auction List block is added and saved.
## Manage the Page
* **View in your store** — Preview the page on your storefront.
* **Adjust Auction List Block** — Reopen the theme editor to change the block.
## Enhance Your Auctions Page
Depending on your plan, you can unlock additional on-page features:
* **Basic** — Wishlists, My Bids, search, and sorting directly on the auctions page.
* **Grow** — An enhanced bidding experience so customers can place bids and follow bidding activity in real time.
## Related Pages
* [Getting Started with Auctions](/auctions/getting-started-with-auctions)
* [Theme Setup](/storefront-setup/theme-setup)
* [Creating an Auction Collection](/storefront-setup/ending-soon-collection)
# Creating an Ending Soon Collection
Auction Plus can create an **Auction collection** for you so customers can browse auction products in one place.
## What the Collection Does
Once active, products automatically appear in this collection based on their auction status. By default, only running auctions are included, but you can also include scheduled and ended listings.
You can use the collection to:
* Feature auctions on your storefront collection pages
* Add auctions to your store navigation
* Build an auction landing page
## Create or Select a Collection
1. In Auction Plus, open **Features > Auctions**.
2. Open the **Create collection** step.
3. Choose one of the following options:
* **Create a new collection** — Enter a title and a URL handle, then click **Create collection**.
* **Select an existing collection** — Click **Select existing collection** to choose a collection that already exists in your Shopify store.
> **Note:** Only smart (automated) collections support automatic auction rules. If you select a manual collection, a warning will appear and auction products will not be added automatically. You can create a new smart collection instead.
## Configure included listings
For smart collections, you can control which auction products appear:
* **Active listings** — Running auctions are always included in the collection.
* **Scheduled listings** — Optionally include auction products that haven't started yet.
* **Ended listings** — Optionally keep auction products in the collection after they have ended.
Toggle these options using the checkboxes under **Included listings**, then save your changes.
## Manage the Collection
After the collection is set up, you can:
* **Edit in Shopify** — Open the collection in your Shopify admin to customize its appearance.
* **View in your store** — Preview the collection on your storefront.
* **Change collection** — Switch to a different existing collection.
* **Unlink** — Remove the collection link from Auction Plus.
## Next Steps
After the collection is active, consider:
* Adding the collection to your store navigation
* Using it as the destination for auction marketing emails or social posts
## Related Pages
* [Getting Started with Auctions](/auctions/getting-started-with-auctions)
* [Theme Setup](/storefront-setup/theme-setup)
# Getting Started with Auctions
Auctions are a powerful way to drive engagement and sales on your Shopify store. With Auction Plus, you can create timed auctions with flexible bidding rules, reserve prices, automatic bids, and more — all integrated seamlessly into your existing storefront and checkout.
## Before You Launch
### How auctions work on your storefront
Auction listings are tied to your existing Shopify products. When you create an auction, you choose a product (or a collection of products) and Auction Plus replaces the standard purchase flow on that product's page with a bidding widget — showing the current price, bid count, and a countdown timer.
Customers can bid from the product page, as well as collection pages on supported plans. When the auction ends, the winner receives an email with a link to add their winnings to their cart. They can then check out through your store's standard checkout flow. The product price is updated to the winning bid amount automatically.
### What you need to set up
Three things must be in place before your auction is visible to customers:
1. **Enable the app embed** — This powers all Auction Plus storefront features (bidding, countdowns, offers). Without it, app features will not appear on your storefront. See [Theme Setup](/storefront-setup/theme-setup).
2. **Create your auction products** — Auctions are tied to your existing Shopify products. You can use your existing products or create new ones for your auction. You can also give customers one place to browse your auctions by creating a dedicated [Auctions Page](/storefront-setup/auctions-page) or an [auction collection](/storefront-setup/ending-soon-collection).
3. **Add auctions to your store navigation** — We recommend adding a link to your auctions page or collection in your store navigation so customers can easily find your auctions. Learn more about navigation in Shopify's [navigation guide](https://help.shopify.com/en/manual/online-store/menus-and-links).
Auction Plus will guide you through setting up your first auction via the [Setup Wizard](/start-here/setup-wizard).
If you are experiencing issues with your auctions not showing on the storefront, see [Common Issues](/troubleshooting/common-issues).
## Creating your First Auction
Creating an auction is as simple as choosing your products, setting your auction rules, and going live. Learn more about creating auctions in our [Creating an Auction](/auctions/creating-an-auction) guide.
## Know These Settings First
We recommend familiarizing yourself with these key auction settings before you create your first auction:
* **Bid increment** controls the minimum next bid
* **Automatic bids** let customers set a hidden maximum
* **Soft close** extends the auction when bids arrive at the end
* **Reserve price** keeps the item from selling below your minimum
See [Auction Listing Settings](/auctions/auction-listing-settings) for the detailed reference.
## After an Auction Ends
When an auction closes:
* The winner will be declared and notified
* The customer checks out through Shopify
* You can follow up on unpaid winners
* You can relist unsold items or send second-chance offers
## Related Pages
* [Creating an Auction](/auctions/creating-an-auction)
* [Managing Auctions](/auctions/managing-auctions)
* [Auction Events](/auctions/auction-events)
* [Declaring and Managing Winners](/auctions/managing-winners-and-second-chance-offers)
* [Common Issues](/troubleshooting/common-issues)
* [FAQ](/troubleshooting/faq)
* [How Checkout Works](/products-and-checkout/get-started-with-orders-and-checkout)
# Creating an Auction
Auction Plus provides three different methods to create your auction: from a new product, existing products, or an entire collection.
## Getting Started
1. Navigate to the **Auctions** page in your Auction Plus dashboard.
2. Click **Create Auction**.
3. Choose one of the three creation methods below.
## Method 1: Create a New Product
Use this method when the item you want to auction is not yet in your Shopify store.
* Enter a **title** for the product.
* Optionally add an **image** and **description**.
* A new product will be created in your Shopify store automatically.
* Configure auction settings on the right side of the page (start price, bid increment, dates, etc.).
## Method 2: Select Existing Products
Use this method to create auctions for products already in your store.
* Click **Select existing products** and browse or search your product catalog.
* Choose one or more products.
* An auction is created for **each selected product**.
* Configure auction settings that will apply to all selected products.
## Method 3: Select a Collection
Use this method to create auctions in bulk from an existing Shopify collection.
* Click **Select a collection** and choose a collection from your store.
* An auction is created for **each product in the collection** (up to 500 products).
* This method **requires an Auction Event**. See [Auction Events](/auctions/auction-events) for details on creating one.
## Setting Different Prices per Listing
When creating auctions in bulk (from multiple products or a collection), the start price and reserve price you set apply to all listings. If you need different prices for each product, there are three approaches:
### Use a percentage-based start price
Set the price as a **percentage of the product price** instead of a fixed amount. Each listing's start price will be calculated from its own product price.
### Import via CSV
Use [CSV Import & Export](/auctions/csv-import-export-guide) to upload listings with individual start prices, reserve prices, and other settings per product. This is the best option when you have a spreadsheet of items with specific pricing.
### Create then edit draft listings
1. Set your auction products in Shopify to **draft** status so they are not visible to customers.
2. Create your auctions listings with a placeholder start price.
3. Use the [Bulk Edit](/auctions/bulk-editing-auctions) feature to set the correct start price and reserve price for each product.
4. Set the products to active status when ready.
## Important Notes
* **One live auction per product at a time.** You cannot have multiple active auctions for the same product. If you need to relist a product, cancel the existing auction first. See [Managing Auctions](/auctions/relisting-auctions) for more details.
* **Only the first variant is used.** If your product has multiple variants, Auction Plus uses the first variant for the auction.
* **Auction settings** such as start price, bid increment, start/end dates, and more are applied to each listing. See [Auction Settings](/auctions/auction-listing-settings) for a full breakdown of each setting.
## What Happens Next
Once you click **Create**, your auction is either:
* **Scheduled** if you set a future start date.
* **Active** immediately if the start date is the current time or in the past.
Your product page in your Shopify store will display the auction widget, allowing customers to place bids.
> **Note:** Configured [Default Auction Settings](/auctions/default-auction-settings) pre-fill when creating a new auction, and you can override them for any individual listing. To save the current settings as your defaults, check **Save as default** in the **Default settings** section before creating.
# Managing Auctions
The Auctions page is your central hub for viewing, editing, and managing all of your auction listings.
***
## Auction List
Your auctions are displayed in a list view containing relevant fields, such as product name, current bid, number of bids, and status.
### Status Filters
* **Active** — Auctions currently accepting bids.
* **Scheduled** — Auctions set to start in the future.
* **Completed** — Auctions that have ended (with or without a winner).
* **Archived** — Auctions moved to the archive.
### Sorting
Sort by creation date, end date, start date, or total bids.
***
## Viewing Auction Details
Click on any auction to open its detail page. Here you can see the current bid, bid history, auction settings, and winner information.
***
## Actions
### Edit
Click **Edit** to modify an auction's settings.
* **Scheduled listings** — All settings can be modified.
* **Active listings** — Some settings are restricted after bids have been placed (for example, you cannot lower the start price below the current bid).
* **Ended listings** — Settings cannot be modified after the auction has ended.
### End Now
Immediately end an active auction before its scheduled end time. If there is an eligible high bidder, they are declared the winner.
### Cancel Listing
Cancel an auction listing entirely. No winner is declared.
### Archive
Move a completed auction to the archive to keep your active list clean. If the auction has an unpaid winner, the winner is **canceled** when archived. Archived auctions can still be viewed using the **Archived** status filter.
### Unarchive
Restore a previously archived auction back to the completed list.
***
## Related
* [Relisting Auctions](/auctions/relisting-auctions)
* [Bulk Editing Auctions](/auctions/bulk-editing-auctions)
* [Default Auction Settings](/auctions/default-auction-settings)
* [Creating an Auction](/auctions/creating-an-auction)
* [Auction Listing Settings](/auctions/auction-listing-settings)
* [Global Auction Settings](/auctions/global-auction-settings)
* [Declaring & Managing Winners](/auctions/managing-winners-and-second-chance-offers)
* [CSV Import & Export](/auctions/csv-import-export-guide)
# Auction Listing Settings
This guide covers all settings available when creating or editing an individual auction listing.
***
## Per-Auction Settings
These settings are configured when creating or editing an individual auction. See [Creating an Auction](/auctions/creating-an-auction) for the creation workflow.
### Start Price
The price at which bidding begins. Required.
* Set this to the minimum amount you want for the first bid.
* Customers cannot bid below this price.
> **Tip:** Combine a low start price with a [Reserve Price](#reserve-price) if you want to encourage bidding activity while still protecting your minimum acceptable price.
### Bid Increment
The minimum amount each new bid must exceed the current bid. Available options:
**Default (Tiered)** — The increment scales automatically with the bid amount:
| Current Bid | Increment |
| --------------------- | --------- |
| $0.01 – $0.99 | $0.05 |
| $1.00 – $4.99 | $0.25 |
| $5.00 – $24.99 | $0.50 |
| $25.00 – $99.99 | $1.00 |
| $100.00 – $249.99 | $2.50 |
| $250.00 – $499.99 | $5.00 |
| $500.00 – $999.99 | $10.00 |
| $1,000.00 – $2,499.99 | $25.00 |
| $2,500.00 – $4,999.99 | $50.00 |
| $5,000.00+ | $100.00 |
**Fixed Amount** — A fixed dollar amount regardless of the current bid (e.g., always $5.00 more).
**Percentage** — A percentage of the current bid (e.g., 10% on a $50 bid means the next bid must be at least $55).
### Reserve Price
The minimum price at which you are willing to sell. The item will not sell if bidding does not reach this amount.
* The reserve price is **not visible** to bidders. They see a message indicating whether the reserve has been met.
* When a proxy bid meets or exceeds the reserve, the showing bid automatically raises to the reserve price.
> **Note:** Reserve Price is available on select plans.
### Start Date and Time
Determines when the auction begins accepting bids. Defaults to immediately. You can schedule auctions in advance by setting a future date and time.
When the auction belongs to an **Auction Event**, start and end dates are managed by the event.
### End Date and Time
When the auction stops accepting bids. Defaults to 7 days from now.
> **Tip:** Consider your audience's timezone when setting end times.
### Accept Offers
Toggle to enable the Make an Offer feature for this listing. When enabled, customers can submit an offer price. The offer option is only available before the first bid is placed.
See [Offers](/offers/get-started-with-offers) for full details.
***
## Automatic Bids (Proxy Bidding)
The Automatic Bids option lets a customer enter the maximum amount they are willing to pay for an item. The system will then automatically place bids for the customer at one increment above the second highest bidder, up to that maximum amount. This is known as a "second-price auction". This allows customers to place their maximum bid once, instead of responding to each and every competing bid that is placed.
> The maximum bid is kept hidden from other bidders until an equal or higher bid is placed.
***
## Soft Close (Anti-Sniping)
Soft Close, or popcorn bidding, extends an auction's end time when bids are placed in the final moments, preventing "sniping."
**Soft Close settings:**
* **Extend From** — The window before end time during which a bid triggers an extension (e.g., 2 minutes before end).
* **Extend Duration** — How much time is added, calculated from when the bid was placed (e.g., 2 minutes from bid time).
> **Note:** Soft Close is available on paid plans.
***
## Next Steps
* Learn about [Default Auction Settings](/auctions/default-auction-settings) to pre-fill values for new auctions.
* Modify multiple auctions at once with [Bulk Editing](/auctions/bulk-editing-auctions).
* Configure store-wide auction options in [Global Auction Settings](/auctions/global-auction-settings).
* Create auctions in bulk with [CSV Import & Export](/auctions/csv-import-export-guide).
# Default Auction Settings
Save the settings from an auction you are creating as the defaults for future auctions. The saved values pre-fill every time you create a new auction.
***
## Saving Defaults
Defaults are saved directly from the **Create Auction** page.
1. Go to **Auctions** and click **Create Auction**, then configure the settings you want to reuse.
2. In the **Default settings** section, check **Save as default**.
3. Click **Create**. The auction is created and your current settings are saved as the new defaults.
> **Note:** Defaults are saved when the auction is created. The checkbox records whatever values are currently entered on the form, so make sure they reflect the defaults you want before creating.
***
## Configurable Defaults
* **Start Price** — Fixed amount or percentage of the product price.
* **Round To** — Rounding applied to percentage-based start prices.
* **Bid Increment** — Fixed amount or percentage.
* **Soft Close** — Enable/disable, Time Left, and Extend By.
* **Automatic Bids** — Enable/disable proxy bidding by default.
* **Make an Offer** — The default offer rule applied to new auctions.
* **Buyer's Premium** — The default product fee applied to new auctions.
***
## How Defaults Work
* Defaults apply to all new auctions created after they are saved.
* Existing auctions are not affected.
* Any default can be overridden on a per-auction basis before you create the auction.
* Saving new defaults overwrites the previous ones.
# Global Auction Settings
These settings apply store-wide and are found under **Settings > Auctions**.
***
## General
* **Enable bidding on collection pages** — Allow customers to bid from collection pages without navigating to individual product pages. See [Collection Bidding](/auctions/collection-bidding).
* **Reveal bidders' full names** — When enabled, bidder full names are visible on auction pages.
* **Auction Countdown Templates** — Select which pages automatically display an auction countdown: Home Page, Collection Pages, and/or Search Page.
* Note: Home Page countdowns are only available for themes that support the feature. If you enable Home Page countdowns but they do not appear, please contact support for assistance.
* **Collection Countdown Style** — Choose how the countdown displays on collection pages:
* **Default** — "Ends in 2 days"
* **Three Column** — Days, hours, and minutes in separate columns.
> **Note:** Collection bidding is available on the Grow plan and above.
***
## Automations
* **Disable auctions on unsold products** — Automatically removes the auction display from products that end without a winner. The product page reverts to a standard "Add to Cart" experience. See [Removing Auctions](/products-and-checkout/removing-auctions-from-storefront) for manual removal options.
* **Send payment reminders** — Toggle automatic payment reminder emails for unpaid wins. When enabled, choose the delay (6, 12, 24, 48, or 72 hours). See [Orders & Checkout](/customers-and-bidders/payment-reminders).
* **Enable payment deadlines** — Require payment for winning bids within the specified timeframe. Overdue items can be canceled automatically or marked for manual review. See [Payment Deadlines and Unpaid Wins](/auctions/payment-deadlines).
* **Automatically cancel overdue wins** — Automatically cancel winning bids that haven't been paid by their deadline. A canceled win is recorded as a non-payment strike against the customer.
* **Automatically ban bidders with multiple unpaid wins** — Ban a customer from bidding after a set number of strikes for unpaid wins. See [Payment Deadlines and Unpaid Wins](/auctions/payment-deadlines#automatically-banning-repeat-offenders).
> **Note:** Automations require a paid plan. Automatic banning requires the Grow plan or above.
***
## Product Template
Select the Shopify product page template to use for auction items.
***
## Registration & Verification
Use this section to control who can bid, what registration fields are shown, and how unapproved customers are handled. See [Bidder Registration](/customers-and-bidders/bidder-registration-and-approval) for the full guide.
***
## Related
* [Auction Listing Settings](/auctions/auction-listing-settings)
* [Default Auction Settings](/auctions/default-auction-settings)
* [Managing Auctions](/auctions/managing-auctions)
* [Collection Bidding](/auctions/collection-bidding)
# Auction Events
By default, each auction listing has its own start and end date that can be managed individually. Auction Events let you group multiple listings under one shared schedule. You set the timing once at the event level, then apply it across all listings. Events are recommended when running more than a few auction listings at once, as they help you manage and schedule items more efficiently.
## Use Cases
* **Weekly auctions:** Host a weekly or monthly auction event with a curated selection of items.
* **Clearance sales:** Auction off end-of-season or surplus inventory in a single event.
* **Charity events:** Organize a fundraising auction with multiple items under one event.
## Creating an Event
Auction Events can be created in one of two ways:
### From the Create Auction Page
When creating a new auction, you can select an existing event or create a new one directly from the auction creation page under **Auctions > Create Auction**.
### From the Events Page
1. Navigate to **Auctions > Manage Events**.
2. Click **Create Event**.
3. Fill in the event details:
* **Name:** A display name for the event (e.g., "Spring Clearance 2026"). This is visible to your team for organization.
* **Start Date/Time:** When all auction listings in the event begin accepting bids.
* **End Date/Time:** When the auction event closes.
> **Note:** When auction listings belong to an event, the start and end times are determined by the event settings. They cannot be edited individually.
## Staggered Closing
Staggered Closing lets you spread out the end times so auction listings close in groups over a period of time.
### Why Use Staggered Closing?
* Prevents all auctions from ending at the exact same moment, which can overwhelm bidders.
* Gives bidders time to focus on each closing group.
* Creates a more exciting, drawn-out event experience.
### How to Configure
1. Enable **Staggered Closing** on the event.
2. Set the **Interval:** The number of auctions per closing group (e.g., 10).
3. Set the **Stagger Seconds:** The time between each group closing (e.g., 60 seconds).
### Example
* You have **100 auctions** in an event ending at **8:00 PM**.
* Interval: **10** auctions per group.
* Stagger Seconds: **60** seconds between groups.
| Group | Auctions | Closing Time |
| ----- | --------- | ------------ |
| 1 | 1 -- 10 | 8:00 PM |
| 2 | 11 -- 20 | 8:01 PM |
| 3 | 21 -- 30 | 8:02 PM |
| 4 | 31 -- 40 | 8:03 PM |
| ... | ... | ... |
| 10 | 91 -- 100 | 8:09 PM |
## Reordering Event Items
The order of listings in an event sets the order they close in. With [staggered closing](#staggered-closing), the first listing closes first, the next closes after the stagger interval, and so on. You can change this order at any time by dragging listings into place.
### How to Reorder
1. Open the event and click **Edit Listings** to open the [bulk edit](/auctions/bulk-editing-auctions) view.
2. Drag a listing by the handle on the left of its row to a new position.
3. The **End Time** column updates instantly to preview how the listings will close in the new order.
4. Click **Save** to apply. The new order is saved and closing times are re-staggered to match it.
> **Note:** Reordering an event that is already running will change the closing times of its open listings, while already closed listings are unaffected.
## Managing Events
From the **Events** page, you can:
* **Edit:** Update the event name, dates, or staggered closing settings.
* **End Early:** Immediately end all auctions in the event before the scheduled end time.
* **Archive:** Move a completed event and its auctions to the archive. This is useful for keeping your active events list clean.
* **Unarchive:** Restore a previously archived event.
## Adding Auctions to an Event
There are two common ways to add auctions to an event:
### When Creating Auctions
Select the event from the **Event** dropdown when [creating an auction](/auctions/creating-an-auction). The auction will inherit the event's start and end times.
### Via CSV Import
Upload a CSV file to import multiple auctions into an event at once. See [CSV Import & Export](/auctions/csv-import-export-guide) for details on formatting and uploading.
## Related Pages
* [Creating an Auction](/auctions/creating-an-auction)
* [CSV Import & Export](/auctions/csv-import-export-guide)
* [Bulk Editing Auctions](/auctions/bulk-editing-auctions)
* [Managing Auctions](/auctions/managing-auctions)
# Declaring and Managing Winners
When an auction ends, Auction Plus handles winner declaration and provides you with tools to manage the post-auction process.
## Automatic Winner Declaration
When an auction ends with bids, the **highest bidder is automatically declared the winner**. No action is required from you.
What happens automatically:
1. The product price is updated to the winning bid amount in your Shopify store.
2. A **winner notification email** is sent to the winning bidder with a link to checkout.
3. A button to proceed with the purchase appears for the winner on the product page.
### Reserve Price Not Met
If an auction has a [reserve price](/auctions/auction-listing-settings#reserve-price) and the highest bid does not reach or exceed it, **no winner is declared**. The auction closes without a sale. You can then choose to [relist the auction](/auctions/relisting-auctions) with a lower reserve, or [send an offer](#sending-offers-from-bids) to one of the bidders.
## Winner Notification
When a winner is declared (automatically or manually), they receive an email containing:
* The item they won and the winning price.
* A link to complete their purchase.
> **Tip:** You can customize winner notification emails in [Customizing Email Templates](/email-and-notifications/customizing-email-templates).
## Cancelling a Winner
If a winner does not pay or a dispute arises, you can cancel the winner:
1. Open the auction detail page.
2. Click **Cancel Winner**.
Use this when:
* The winner **does not complete payment** within a reasonable time.
* There is a **dispute** that needs to be resolved.
* You need to **relist the item** or send an offer to a different winner.
After cancelling a winner, you can:
* [Send an offer to another bidder](#sending-offers-from-bids).
* [Relist the auction](/auctions/relisting-auctions).
> **Note:** Wins can also be canceled automatically when a payment deadline passes. See [Payment Deadlines and Unpaid Wins](/auctions/payment-deadlines).
## Sending Offers from Bids
You can send a **second-chance offer** to any bidder who did not win the listing from the **Top Bidders** list on the auction detail page.
1. Open the auction detail page.
2. Visit the Top Bidders section.
3. Click **Send Offer** next to the bidder you want to send an offer to.
This sends the bidder an offer at their highest bid, giving them the opportunity to purchase the item. This is especially useful when the original winner does not pay.
## Important Notes
* **Multiple winners are not supported** per auction. Only one bidder can be declared the winner at a time.
* If you need to sell to multiple bidders, consider creating separate auction listings for each unit of inventory, or use the Send Offer feature to send offers to runner-up bidders.
## Related Pages
* [Managing Auctions](/auctions/managing-auctions)
* [Relisting Auctions](/auctions/relisting-auctions)
* [Proxy Bidding](/auctions/auction-listing-settings#proxy-bidding-automatic-bids)
# Payment Deadlines and Unpaid Wins
Payment deadlines give auction winners a fixed window to pay. When a deadline passes without payment, Auction Plus can cancel the win automatically, record a non-payment strike against the customer, and—after repeated strikes—ban the customer from bidding.
These settings are found under **Settings > Auctions** in the **Automations** section.
> **Note:** Payment deadlines and automatic cancellation are available on the Basic plan and above. Automatic banning is available on the Grow plan and above.
***
## How It Works
1. When an auction ends, the highest bidder is [declared the winner](/auctions/managing-winners-and-second-chance-offers) and a payment deadline is set on their win.
2. If the deadline passes without payment and **Automatically cancel overdue wins** is on, the win is canceled and a non-payment strike is recorded against the customer.
3. If the customer reaches your strike threshold and **Automatically ban bidders with multiple unpaid wins** is on, they are banned from placing further bids.
***
## Setting a Payment Deadline
1. Navigate to **Settings > Auctions**.
2. Find the **Automations** section.
3. Turn on **Enable payment deadlines**.
4. Choose **Due within** and select a timeframe (1 to 30 days).
5. Click **Save**.
The deadline is calculated when the winner is declared. Leave **Enable payment deadlines** off to declare winners with no payment deadline.
***
## Automatically Canceling Overdue Wins
When **Enable payment deadlines** is on, you can also turn on **Automatically cancel overdue wins**.
When a winning bid's payment deadline has passed and no payment has been received, the win is canceled and a non-payment strike is recorded against the customer.
The product is **not** relisted automatically. After a win is canceled you can [relist the auction](/auctions/relisting-auctions) or [send a second-chance offer](/auctions/managing-winners-and-second-chance-offers#sending-offers-from-bids) to another bidder.
Turn **Automatically cancel overdue wins** off to leave overdue wins in place for [manual review](/auctions/managing-winners-and-second-chance-offers#cancelling-a-winner).
***
## Strikes
A non-payment strike is recorded each time a win is canceled for non-payment—both when it's canceled automatically and when you cancel it manually and select non-payment as the reason. You can see a customer's total strikes on their detail page under **Non-Payment Strikes**.
Strikes are used to drive automatic banning. Customers are not notified when a strike is recorded.
***
## Automatically Banning Repeat Offenders
To ban customers who repeatedly fail to pay:
1. Navigate to **Settings > Auctions**.
2. Find the **Automations** section.
3. Turn on **Automatically ban bidders with multiple unpaid wins**.
4. Choose **Ban after** and select a number of strikes (2 to 5).
5. Click **Save**.
When a customer reaches the strike threshold, they are banned automatically. A banned customer cannot place bids or make offers. Their existing maximum bids remain active until they are outbid or removed manually.
You can ban and unban customers manually at any time. See [Banning Customers](/customers-and-bidders/banning-customers).
> **Note:** Automatic banning is available on the Grow plan and above.
***
## Related
* [Declaring and Managing Winners](/auctions/managing-winners-and-second-chance-offers)
* [Global Auction Settings](/auctions/global-auction-settings)
* [Payment Reminders](/customers-and-bidders/payment-reminders)
* [Banning Customers](/customers-and-bidders/banning-customers)
# Relisting Auctions
Relisting creates a new auction for a product that has already been auctioned. Use this when:
* The item **did not sell** (no bids, or the reserve price was not met).
* The winner **did not pay** and you have cancelled the winner.
* You have **additional inventory** of the same product.
***
## Before You Relist
Cancel any existing unpaid or scheduled auction listings for the product first. Only one live auction per product is allowed at a time.
***
## Relisting an Individual Product
1. Navigate to **Create Auction**.
2. Select **Select existing products**.
3. Search for and choose the product(s) you want to relist.
4. Configure the new auction settings.
5. Click **Create**.
***
## Relisting a Collection
1. Navigate to **Create Auction**.
2. Select **Select a collection** and choose the collection.
3. An auction is created for each product in the collection (up to 500 products). This method requires an [Auction Event](broken://pages/1QAwJm5tmpOyrrzjN6tX).
4. Configure shared settings and click **Create**.
You can also use [CSV Import](/auctions/csv-import-export-guide) to batch-import auctions into an event.
***
## Troubleshooting Relist Errors
You will see an error when trying to create an auction for a product that already has an active listing.
To resolve:
1. Navigate to the latest auction listing for the product.
2. **If the listing has an unpaid winner:** Click **Cancel Winner** to release the product.
3. **If the listing is scheduled:** Click **Cancel Listing**.
4. Return to **Create Auction** and relist the product.
***
## Tips
* Review the previous auction's bid history before relisting. If there were no bids, consider adjusting the start price or auction duration.
* If a winner did not pay, you can [send a second-chance offer](/auctions/managing-winners-and-second-chance-offers#sending-offers-from-bids) to a runner-up bidder instead of relisting.
# Bulk Editing Auctions
Bulk editing lets you modify settings for multiple auctions at once.
***
## Accessing Bulk Edit
* From an **Auction Event** page — edit all listings in the event by pressing the **Edit Listings** button.
* From the **Auctions list** — select multiple auctions and choose the **Bulk Edit** option.
***
## How It Works
1. Open the bulk edit view (up to 50 auctions per page).
2. Modify the settings you want to change for each row.
3. Click **Save** to apply all changes. Valid rows are saved even if other rows have errors.
***
## Editable Fields
| Field | Description |
| ----------------------------- | ----------------------------------------- |
| Start Price ($) | Starting bid price (required) |
| Reserve Price ($) | Minimum price for the item to sell |
| Bid Increment ($) | Fixed dollar amount increment |
| Bid Increment % | Percentage-based increment |
| Enable Soft Close | Enable or disable soft close |
| Soft Close From (seconds) | Seconds before end to activate soft close |
| Soft Close Duration (seconds) | Seconds to extend per bid |
| Allow Proxy Bids | Enable or disable proxy bidding |
> Bulk editing is limited to scheduled auctions and listings that have not yet received bids. For large batches, consider [CSV Import & Export](/auctions/csv-import-export-guide) instead.
***
## Reordering Listings in an Event
When you open an **Auction Event** in bulk edit, each row has a drag handle on its left, alongside a read-only **End Time** column. Drag a listing up or down to change its position in the event.
The new order is applied when you click **Save**, along with any other edits. See [Auction Events](/auctions/auction-events#reordering-lots) for how the order affects closing times.
# CSV Import Guide
Use CSV import when you want to add many auction listings to the same event at once.
## Before You Begin
Make sure:
* Your plan includes CSV import
* You have created an [auction event](/auctions/auction-events)
* You have created the products in Shopify
## Creating Your CSV File
You can create your CSV file in Excel, Google Sheets, or any other spreadsheet software. We recommend first adding a listing to your auction event manually, then exporting that listing to CSV. This gives you a template with the correct column headers and formatting.
## Recommended Workflow
Once you have your CSV file ready, follow these steps to import your listings:
1. Open your auction event.
2. Click **Import from CSV**.
3. Review the column mapping.
4. Check the preview rows.
5. Start the import.
The import runs in the background, so you can keep working while it processes.
## Common Import Problems
### Product not found
Double-check the Shopify product handle.
### Offer rule not found
Create the offer rule first, then use the exact same name in the CSV.
### Product fee not found
Create the product fee first, then use the exact same name in the CSV.
### Import already in progress
Only one CSV import can run at a time. Wait for the first import to finish before starting another.
## Limits
* Maximum rows per import: `500`
If you need a higher limit, contact `support@auctionplusapp.com`.
## Column Reference
Use the separate [CSV Column Reference](/auctions/csv-column-reference) for required fields, optional fields, and formatting notes.
## Related Pages
* [Auction Events](/auctions/auction-events)
* [CSV Column Reference](/auctions/csv-column-reference)
* [Creating an Auction](/auctions/creating-an-auction)
# CSV Column Reference
This page provides a reference for the columns used in CSV imports for auction listings. Use this as a guide when creating your CSV file to ensure proper formatting and successful imports.
## Required Columns
Every import must include these columns:
| Column | Description | Example |
| -------------- | -------------------------- | --------------- |
| Product Handle | The Shopify product handle | `vintage-watch` |
| Start Price | The opening bid amount | `99.00` |
## Optional Columns
| Column | Description | Example |
| ----------------------------- | ---------------------------------------------------- | -------------- |
| Reserve Price | Hidden minimum sale price | `150.00` |
| Bid Increment | Fixed bid increase amount | `5.00` |
| Bid Increment % | Percentage bid increase | `10` |
| Automatic Bids | Enable proxy bidding | `true` |
| Enable Soft Close | Extend the auction near the end | `true` |
| Soft Close From (seconds) | Window before end time that can trigger an extension | `120` |
| Soft Close Duration (seconds) | Time added when soft close triggers | `120` |
| Offer Rule Name | Existing offer rule name | `10% off` |
| Product Fee Name | Existing product fee name | `Standard Fee` |
## Important Rules
* For fixed or percentage increments, provide either **Bid Increment** or **Bid Increment %**, not both.
* To apply the default [Bid Increment](/auctions/auction-listing-settings#bid-increment) tiers, leave both **Bid Increment** and **Bid Increment %** blank.
* Leave optional cells blank if you do not want to set a value.
* Offer rule names and product fee names must match existing records exactly.
## Tip
If you are unsure about formatting, export listings from an existing event and use that file as your template.
## Related Pages
* [CSV Import Guide](/auctions/csv-import-export-guide)
* [Auction Events](/auctions/auction-events)
# Collection Bidding
Collection Bidding allows your customers to place bids directly from Shopify collection pages, without needing to navigate to individual product pages.
> **Note:** Collection Bidding is available on the **Grow plan and above**. Check your [plan details](https://admin.shopify.com/apps/auction-plus/plans) to confirm availability.
## Enabling Collection Bidding
1. Navigate to **Settings > Auctions**.
2. Toggle **Enable Collection Bidding** to on.
## Countdown Display Options
You can choose how the auction countdown is displayed on collection pages:
### Default Countdown
Shows the time remaining in a natural language format.
**Example:** 2 days left
### Three Column Countdown
Shows the days, hours, and minutes or seconds left in separate columns.
**Example:**
## How It Works for Customers
1. A customer visits a collection page in your store.
2. Products with active auctions show a countdown timer and current bid.
3. The customer clicks the **bid button** on any item they are interested in.
4. They enter their bid amount and submit -- all without leaving the collection page.
5. For more details, they can click through to the individual product page.
## Related Pages
* [Creating an Auction](/auctions/creating-an-auction)
* [Auction Events](/auctions/auction-events)
* [Auction Settings](/auctions/auction-listing-settings)
# Get Started with Offers
The Make an Offer feature lets customers propose a price on your products that you can manually or automatically accept, decline, or counter. It works like a private negotiation between you and the customer, right on your storefront.
> **Note:** Offers require a paid plan. See [Plans & Billing](https://admin.shopify.com/apps/auction-plus/plans) for details.
## How offers work
1. A customer visits a product page and clicks **Make an Offer**.
2. They enter a price and an optional message.
3. Based on your [offer rules](/offers/offer-rules), the offer is either handled automatically or sent to you for review.
4. You can **accept**, **decline**, **counter** with a different price, or **cancel** an offer you have already sent. The customer can accept, decline, or counter in return.
5. When an offer is accepted, the customer receives an email with a link to check out at the agreed price through your standard Shopify checkout.
Offers can also appear on auction listings before the first bid is placed. Once bidding starts, the offer option is removed from that listing. When an offer on an auction listing is accepted, the auction ends immediately and the product is awarded to the customer.
Each offer has an expiration period configured in your offer rules. If neither party responds within that timeframe, the offer expires automatically.
## Setting up offers
Open **Features > Make an Offer** for guided setup, or follow these steps:
1. **Enable the app embed** — Required for all Auction Plus storefront features. See [Theme Setup](/storefront-setup/theme-setup).
2. **Create an offer rule** — Rules control which products show the Make an Offer button and how offers are handled (auto-accept, auto-decline, or manual review). You need at least one active rule for the button to appear. See [Offer Rules](/offers/offer-rules).
3. **Preview a product page** — Visit a product that matches your rule to confirm the Make an Offer button appears.
You can optionally add the [Make Offer button](/storefront-setup/adding-offer-button) manually to your theme for more control over placement.
## Offer rules and automation
Offer rules are required to activate the Make an Offer button on your storefront. Each rule controls which products accept offers, and the settings for handling those offers.
See [Offer Rules](/offers/offer-rules) for details on how to set up rules and use automation to save time managing offers.
## Email notifications
When a customer submits an offer or counters your offer, you receive an email notification at your store's contact email address. These notifications can be enabled or disabled in **Settings > Notifications** under the **Admin Notifications** card.
Customers also receive email notifications when you accept, decline, or counter their offer. See [Notification Types](/email-and-notifications/notification-types) for the full list.
## Customize the chat appearance
From the Make an Offer setup flow, you can adjust the seller name, chat bubble background color, and text color to match your storefront branding. After setup is complete, you can edit these settings from **Features > Make an Offer**.
## Related Pages
* [Managing Offers](/offers/managing-offers)
* [Offer Rules](/offers/offer-rules)
* [How Checkout Works](/products-and-checkout/get-started-with-orders-and-checkout)
# Managing Offers
Navigate to the **Offers** page in your dashboard to see all offers.
***
## Filtering Offers
| Tab | Description |
| ------------ | ----------------------------------------------- |
| **Review** | Offers waiting for your response |
| **Sent** | Offers you've sent awaiting a customer response |
| **Accepted** | Accepted offers |
| **Declined** | Declined offers |
| **Expired** | Offers that expired without a response |
Use the search bar to find offers by customer name, email, or product name.
***
## Offer Threads
Every offer creates a conversation thread that captures the full negotiation history: the original offer, counter-offers, messages, and the final outcome. Both you and the customer can view the thread.
Thread statuses mirror the filter tabs above (Review, Sent, Accepted, Declined, Expired).
Both parties can include messages with any offer or counter. Use messages to explain your counter, ask questions, or provide additional product details.
***
## Tips
* **Respond quickly.** Customers are more likely to complete a purchase with a fast response.
* **Use counter-offers** instead of outright declines to keep negotiations going.
# Offer Rules
Offer Rules let you automate how incoming offers are handled based on price thresholds you set. You can mannually review every offer, or set rules to automatically accept, decline, or counter offers that meet your criteria.
***
## Creating a New Rule
1. Navigate to **Offers > Manage Rules** in your dashboard.
2. Click **Create Rule**.
3. Fill in the rule settings described below.
4. Click **Save**.
***
## Rule Settings
### Rule Name
Enter a descriptive name for your rule. For example: "Auto-accept up to 15% off" or "Decline low-ball auction offers."
### Listing Type
Choose which type of listing this rule applies to:
* **Products** -- Standard product listings.
* **Auctions** -- Auction listings.
### Apply To
Choose the scope of the rule:
* **All products** -- The rule applies to all products in your store
* **Specific collections** -- The rule applies only to products within selected Shopify collections.
* **Specific products/variants** -- The rule applies only to specific products or variants you select.
### Auto Accept Threshold
Set the maximum discount you're willing to accept:
* **Discount Percentage** -- A percentage discount from the product price.
* **Discount Amount** -- A fixed dollar amount off the product price.
Enter the maximum amount or percentage you're willing to discount from the product price.
For example, if you set a 10% discount and a product is listed for $100.00, any offer of $90.00 or more will be automatically accepted.
### Auto Decline Threshold
Set the maximum discount you're willing to consider before declining:
* **Discount Percentage** -- A percentage discount from the product price.
* **Discount Amount** -- A fixed dollar amount off the product price.
Enter the maximum amount or percentage you're willing to discount before automatically declining an offer.
For example, if you set a 10% discount and a product is listed for $100.00, any offer that is less than $90.00 will be automatically declined.
### Auto-Counter
Toggle this on to automatically send a counter-offer at your auto accept threshold when an offer falls between your auto accept and auto decline thresholds.
### Offer Duration
Set how long offers remain valid before they expire automatically.
### Max Offers Per Customer
Limit the number of offers a single customer can submit on a given product per day, or per auction listing.
### Status
* **Active** -- The rule takes effect immediately.
* **Disabled** -- The rule is saved but won't process offers until you activate it.
***
## Rules Hierarchy
When multiple rules could apply to the same product, Auction Plus uses the most specific rule:
1. **Specific product rules** take priority over other rules.
2. **Specific collection rules** take priority over "all product" rules.
3. **All products rules** are used when no other rules apply.
***
## Editing a Rule
1. Navigate to **Offers > Manage Rules**.
2. Click on the rule you want to edit.
3. Make your changes.
4. Click **Save**.
***
## Deleting a Rule
1. Navigate to **Offers > Manage Rules**.
2. Click on the rule you want to delete.
3. Click **Delete** on the rule detail page.
4. Confirm the deletion.
> **Note:** Deleting a rule is permanent. Any offers that were already processed by the rule are not affected, but future offers will no longer be processed by that rule.
***
## Fully Automating Offers
To have Auction Plus handle all offers without any manual intervention, configure both the auto accept and auto decline thresholds to the same value. For example:
1. **Auto Accept Threshold** -- $10 fixed max discount amount
2. **Auto Decline Threshold** -- $10 fixed max discount amount
In this scenerio, if a product is listed for $100.00, any offer of $90.00 or more will be automatically accepted. Any offer less than $90.00 will be automatically declined. If the Auto Counter option is toggled, any offer of less than $90.00 will receive an automatic counteroffer of $90.00.
***
## Next Steps
* Learn about the full offers workflow in [Get Started with Offers](/offers/get-started-with-offers).
* Manage incoming offers from the [Offers page](/offers/managing-offers).
# Getting Started with Watchlists
Watchlists, also known as Wishlists or the Following feature, let customers save and share products and auction listings from your storefront.
> **Note:** The Following feature requires a paid plan. See [Plans & Billing](https://admin.shopify.com/apps/auction-plus/plans) for details.
## Enable the Following feature
1. Open **Settings > Following**.
2. Turn the feature on.
3. Save your changes.
You can also complete setup from the [Setup Wizard](/start-here/setup-wizard).
## Add the Storefront App Blocks
After enabling the Following feature, set up the storefront experience:
1. [Add the Follow button](/storefront-setup/adding-follow-button) to product pages.
2. Add the Following page button to your store header from the **Features > Following** flow.
## Require Login
If you only want signed-in customers to save items:
1. Open **Settings > Following**.
2. Turn on the login requirement.
3. Save your changes.
This keeps saved items tied to a customer account.
## What customers see
After setup, customers can:
* Click **Follow** on a product page to save it to a list
* Create additional named lists to organize items
* Share their lists with others
Customers manage their saved items from the Following page:
```
https://yourstore.com/apps/auction-plus/watchlists/
```
From this page they can review saved items, remove items, and copy share links.
## Related Pages
* [Adding the Follow Button](/storefront-setup/adding-follow-button)
# Product Fees
Product Fees let you add an additional fee on top of the product price at checkout.
> Product Fees are available on the **Grow plan and above**. See [Plans & Billing](https://admin.shopify.com/apps/auction-plus/plans) for more details.
***
## How Product Fees Work
When a customer purchases a product with a fee applied, the fee is automatically added at checkout through Shopify's product bundle feature. The customer sees the fee as a separate line item so they know exactly what they're paying.
> **Notice:** Auction Plus creates a product in your Shopify store for each fee, which is bundled into checkout. If this product is deleted from Shopify, fees will not be applied at checkout. To ensure fees are applied correctly, do not delete or modify this product.
***
## Fee Types
You can choose between two fee structures:
* **Percentage** -- The fee is calculated as a percentage of the product price. For example, a 10% fee on a $100 product adds a $10 fee at checkout.
* **Fixed** -- The fee is a flat dollar amount regardless of the product price. For example, add a $5 fee to the product price at checkout.
***
## Creating a Fee
1. Navigate to **Products > Manage Fees** in your dashboard.
2. Click **Create Fee**.
3. Configure the settings
4. Click **Save**.
## Fee Settings
### Fee Name
Enter a name for the fee. This name is shown to customers at checkout, so use something clear like "Buyer's Premium" or "Processing Fee."
### Listing Type
Choose which type of listing the fee applies to:
* **Products** -- Standard product listings.
* **Auctions** -- Auction listings.
### Apply To
Choose the scope of the fee:
* **All** -- The fee applies to all products and auctions.
* **Specific Collections** -- The fee applies only to products within selected Shopify collections.
* **Specific Products** -- The fee applies only to specific products you select.
* **Auctions** -- The fee applies only to specific auction listings you select.
> **Note:** Product-type fees (All, Specific Collections, or Specific Products) also apply to auction items at checkout if the auction is tied to a matching Shopify product.
### Fee Type and Amount
Choose **Percentage** or **Fixed**, then enter the amount.
### Status
* **Active** -- The fee is live and will be applied at checkout.
* **Disabled** -- The fee is saved but won't be applied until you activate it.
***
## Fee Hierarchy
When multiple fees could apply to the same product, Auction Plus uses the most specific fee:
1. **Specific product fees** take priority over everything else.
2. **Specific collection fees** take priority over "all" fees.
3. **"All" fees** are used when no other rules apply.
> **Note:** Only one fee is applied per product. The most specific matching fee is applied -- fees are not stacked on top of each other.
# Removing Auctions from the Storefront
After an auction ends, the auction countdown and bidding form remain on the product page until you disable them. When you no longer want a product to display as an auction, disable it to return to a standard product listing.
***
## Disable auctions for a single product
First, open the details page of an auction by selecting the auction listing from the Auctions page. Select the Product Actions dropdown then Disable auctions.
> The Disable auctions option will appear after an auction has concluded. To disable a live auction, please cancel or end the auction first.
***
## Disable auctions for multiple products
Auction listings can be disabled and removed from your storefront's product page in bulk. First, navigate to the Products page in Auction Plus. Select the On Auction tab, then select the products for which you would like to remove the auction display. Select Disable auctions on the right-hand side.
***
## Automatically disable auctions
Auction listings can be automatically disabled and removed from your storefront's product page after a listing ends without a winner. To enable this feature, open **Settings > Auctions**, then turn on **Disable auctions on unsold products** in the **Automations** section.
> **Note:** Automations are available on all paid plans.
***
## What Happens When Auctions Are Disabled
When you disable auctions on a product, the following changes take effect:
* The **auction countdown and bidding form** are removed from the product page.
* The standard **"Add to Cart" button** returns to the product page.
* Auction-related **metafields are cleaned up** from the product.
The product itself is not deleted or modified in Shopify -- it simply goes back to being a normal product listing.
***
## Next Steps
* Understand how to restrict purchases on auction products in [Restricting Purchases for Auction Products](/products-and-checkout/restricting-purchases-for-auction-products).
# Restricting Purchases for Auction Products
When a product is on auction, Auction Plus attempts to automatically remove the "Add to Cart" button from the product page so customers can only participate through bidding. However, there are a few additional steps you should take to ensure full purchase restriction.
***
## What Auction Plus Does Automatically
When auctions are enabled on a product, Auction Plus:
* **Removes the "Add to Cart" button** from the product page.
* **Replaces it with the bidding form** so customers can place bids instead of purchasing directly.
This works out of the box on most Shopify themes, however some themes may require additional adjustments to fully restrict purchases.
***
## Additional Steps for Full Restriction
Before running an auction campaign, we recommend reviewing the following areas to ensure customers can only purchase through the auction process:
### 1. Sales Channels
Ensure auction products are only published to the **Online Store** sales channel. If a product is also published to other channels (Shop, Facebook, Instagram, Google, etc.), customers could purchase it through those channels and bypass the auction.
To check and update sales channels:
1. Open the product in your **Shopify admin**.
2. Scroll to the **Publishing** section.
3. Remove the product from all sales channels except **Online Store** and optionally **Point of Sale** if you want to allow in-person purchases.
4. Click **Save**.
### 2. Third-Party App Conflicts
Some Shopify apps may add their own "Add to Cart" functionality that can conflict with Auction Plus. Common cases include:
* **Wishlist apps** that include "Add to Cart" buttons on wishlist pages.
* **Sticky cart or quick-buy apps** that add floating cart buttons.
* **Product recommendation apps** that show "Add to Cart" on recommended product cards.
If you notice customers can still add auction products to their cart, check whether any installed apps are adding cart functionality. Disable or configure those apps to exclude auction products, or contact our support team for help resolving any issues.
### 3. Theme-Specific Issues
Some Shopify themes display "Add to Cart" buttons on collection pages, quick-view modals, or other locations that Auction Plus may not control. If you see this happening in your theme, contact our support team for help with theme-specific adjustments.
* **Email:**
***
## Next Steps
* Learn how to remove auctions from products in [Removing Auctions from Storefront](/products-and-checkout/removing-auctions-from-storefront).
# How Checkout Works
When a customer wins an auction or has an offer accepted, they complete payment through your standard Shopify checkout. This guide covers the checkout flow, the Ready for Checkout page, and payment reminders.
***
## Checkout Flow
### Auction Wins
1. **Auction ends** — The highest bidder is automatically declared the winner. If a reserve price is set, the winner is only declared if bidding reached the reserve.
2. **Price is updated** — The product price is updated to the winning bid amount.
3. **Winner is notified** — The winner receives an email with a link to the Ready for Checkout page.
4. **Shopify checkout** — The customer adds their items to the cart and checks out through your store's standard Shopify checkout.
### Accepted Offers
1. **Offer accepted** — You accept the offer from the Offers page.
2. **Customer is notified** — The customer receives an email with a link to the Ready for Checkout page.
3. **Shopify checkout** — The customer proceeds through your store's standard Shopify checkout.
### Product Fees (Buyer's Premium)
If you have [product fees](/products-and-checkout/product-fees-and-buyers-premium) configured, the fee is automatically added at checkout as a separate line item. The fee is calculated based on the winning bid or offer amount.
### Multiple Wins
Customers can combine multiple auction wins, accepted offers, and regular store products into a single cart and check out in one transaction.
> Because Auction Plus uses your Shopify checkout, customers benefit from all the payment methods, shipping options, and tax calculations you already have configured.
***
## The Ready for Checkout Page
The Ready for Checkout page lists all outstanding items a customer owes payment for. The URL is:
```
https://yourstore.com/apps/auction-plus
```
### How Customers Access It
* **Winner notification email** — Every win notification includes a direct link. This is the most common path.
* **Customer account navigation** — For stores using Shopify's new customer accounts, add a link via the Checkout Editor (see [Customer Accounts](/start-here/customer-accounts)).
* **Direct URL** — Share `https://yourstore.com/apps/auction-plus` via email or as a menu item. Logged-in customers see their own items.
***
## Tips
* Set up [Payment Reminders](/customers-and-bidders/payment-reminders) to follow up with customers who haven't paid.
* If a customer fails to pay within a reasonable timeframe, consider [banning them](/customers-and-bidders/banning-customers) or sending a second-chance offer to a runner-up bidder. See [Declaring Winners](/auctions/managing-winners-and-second-chance-offers).
# Managing Customers
The Customers page is your central hub for managing everyone who has interacted with your auctions. From here you can view customer details, track bidding activity, ban customers, approve bidders, and send payment reminders.
***
## Navigating to Customers
Open the **Auction Plus** dashboard and click **Customers** in the left-hand navigation menu.
***
## The Customer List
The Customers page displays a table of all customers who have registered or placed bids.
### Filtering
| Tab | Description |
| --------------------- | ------------------------------------------------------------------------------ |
| **All** | Every customer that has interacted with Auction Plus |
| **Active** | Customers in good standing |
| **Banned** | Customers banned from bidding |
| **Awaiting Payment** | Customers with unpaid auction wins or offers |
| **Awaiting Approval** | Customers waiting for approval to bid (when invited-customers mode is enabled) |
You can also search by name or email using the search bar.
***
## Customer Detail Page
Click on any customer to open their detail page.
### Actions
| Action | Description |
| ----------------------------------------- | --------------------------------------------------------------------------- |
| **Ban / Unban** | Block or restore the customer's ability to bid and make offers |
| **Send Payment Reminder** | Manually send a reminder email for unpaid items |
| **Manage Customer** | Open the customer's Shopify admin profile |
| **Mark as Registered / Unregistered** | Toggle registration status (when bidder registration is enabled) |
| **Approve for Bidding / Remove Approval** | Allow or revoke bidding permission (when invited-customers mode is enabled) |
***
## Related
* [Banning Customers](/customers-and-bidders/banning-customers)
* [Bulk Customer Actions](/customers-and-bidders/bulk-customer-actions)
* [Adding an Auctions Link to Customer Accounts](/customers-and-bidders/adding-an-auctions-link-to-customer-accounts)
* [Bidder Registration & Approval](/customers-and-bidders/bidder-registration-and-approval)
* [Payment Reminders](/customers-and-bidders/payment-reminders)
# Banning Customers
Banning prevents a customer from placing bids and making offers.
***
## How to Ban
1. Navigate to the **Customers** page.
2. Search for or click on the customer you want to ban.
3. On the customer detail page, click **Ban Customer**.
The ban takes effect immediately. Existing maximum bids from the customer remain active until they are outbid or manually deleted.
> **Tip:** To remove a banned customer's bids, check the **High Bids** section on their detail page and click through to each auction listing to delete the bid.
***
## How to Unban
1. Use the **Banned** filter tab to find the customer.
2. Click to open their detail page.
3. Click **Unban Customer**.
The customer's status returns to Active immediately.
***
## Automatic Bans
Customers can be banned automatically after repeatedly failing to pay for wins. Each win canceled for non-payment records a strike, and customers who reach your strike threshold are banned from bidding. See [Payment Deadlines and Unpaid Wins](/auctions/payment-deadlines#automatically-banning-repeat-offenders) to configure this.
# Bulk Customer Actions
Bulk actions let you take action on multiple customers at once.
1. Navigate to the **Customers** page.
2. Use the checkboxes to select customers.
3. Choose an action from the bulk action bar.
***
## Available Bulk Actions
**Send Payment Reminders** — Sends reminder emails to selected customers with unpaid items. Limited to one reminder per customer per 12-hour period.
**Approve** — Approve selected customers for bidding (only available when invited-customers mode is enabled). Approves all selected customers in "Awaiting Approval" state.
**Unapprove** — Remove approval from selected customers. Available when invited-customers mode is enabled.
> **Tip:** Filter by status before selecting to quickly target the right group.
## Next Steps
* [Bidder Registration and Approval](/customers-and-bidders/bidder-registration-and-approval) — Learn how to manage bidder registration and approval settings.
# Adding an Auctions Link to Customer Accounts
For stores using Shopify's new customer accounts, consider adding a menu item so customers can easily access their Ready for Checkout page.
1. In your Shopify admin, navigate to **Content > Menus**.
2. Click **Customer account main menu**.
3. Click **Add menu item**.
4. Set the **Label** to `My Auctions`.
5. Set the **Link** to `/apps/auction-plus`.
6. Click **Save**.
***
## Troubleshooting
| Issue | Solution |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| "My Auctions" link not appearing | Save your changes in **Customer account main menu** and refresh the customer account page |
| Customers see a blank page at `/apps/auction-plus` | Make sure the Auction Plus app embed is enabled. See [Theme Setup](/storefront-setup/theme-setup) |
# Bidder Registration and Approval
Use the **Registration & Verification** card under **Settings > Auctions** to control who can bid and what information customers must provide before bidding.
> **Note:** Bidder Registration is available on the **Grow plan and above**. See [Plans & Billing](https://admin.shopify.com/apps/auction-plus/plans) for more details.
## Auction Participant Modes
In the **Registration & Verification** section, choose one of these options under **Auction participants**:
### All customers
Any customer with a store account can bid. No extra registration or approval is required.
### All registered customers
Customers must complete a registration form before placing their first bid. After they register, they can bid right away.
### Invited customers
Only pre-approved customers can bid. Choose whether to require customers to fill out a registration form to request access, or link to a custom page with instructions on how to get approved.
See [Invite-Only Options](#invite-only-options).
## Registration Fields
When registration is enabled, you can choose which fields to collect:
* **First and last name**
* **Phone number** as required or optional
* **SMS marketing consent** when phone collection is enabled
The SMS consent text can be customized from [Translations](/translations/multi-language-support).
## Registration Logo
You can brand the registration form with a logo. Available options include:
* **Shop Logo**
* **Import from theme**
* **Custom URL**
You can also control the displayed logo width.
## Invite-Only Options
When **Invited customers** is selected, you control two things: whether customers fill out a registration form, and the behavior of the bid button for unapproved customers.
* **Require registration** — Show a form to collect name, phone number, and SMS marketing consent. Use this if customers should request access through the form.
* **Disable registration** — No registration form is presented to customers. Useful when access is gated by a purchase or subscription. This option can be paired with **Automatically approve customers with purchase history** to auto-approve customers who have purchased a pass, subscription, or other product on your store.
### Require registration
Under **Registration access**, choose who sees the form:
* **Allow anyone to register** — Anyone who has not registered are presented with the registration form after clicking the bid button. Submitting it creates a pending request on the Customers page for you to approve or reject.
* **Only approved customers can register** — The form is only shown to customers you've already approved (by email, phone, or another process). Unapproved customers are directed to a URL you specify — typically a page explaining how to request access. Best for private or invite-only auctions.
### Disable registration
The customer will not be presented with a registration form, and can start bidding immediately after you approve them from the Customers page.
Under **Unapproved customer action**, choose how the bid button behaves for unapproved customers:
* **Link to a page** — The bid button links to a URL you specify (for example, a page explaining how to request access).
* **Hide bid button** — Unapproved customers see the current price and countdown, but the bid button is hidden until they are approved.
## Purchase History Approval
Select this option to automatically approve customers who have previously purchased from your store.
## Approving Customers Manually
1. Open the **Customers** page
2. Filter to customers awaiting approval
3. Open the customer record
4. Approve or remove bidding approval as needed
> You can bulk approve or unapprove customers from the customer list view. See [Bulk Customer Actions](/customers-and-bidders/bulk-customer-actions) for details.
## Related Pages
* [Managing Customers](/customers-and-bidders/managing-customers)
* [Banning Customers](/customers-and-bidders/banning-customers)
* [Payment Reminders](/customers-and-bidders/payment-reminders)
# Payment Reminders
Payment reminders help you follow up with customers who have won items or had offers accepted but haven't yet paid.
***
## Automatic Reminders
Auction Plus can send reminders automatically after a configurable delay.
1. Navigate to **Settings > Auctions**.
2. Find the **Automations** section.
3. Turn on **Send payment reminders**.
4. Choose **Send reminder after** and select 6, 12, 24, 48, or 72 hours.
5. Click **Save**.
Leave the delay unset to disable automatic reminders.
> **Note:** Payment reminders are available on all paid plans.
***
## Manual Reminders
**Send to one customer:**
1. Navigate to the **Customers** page.
2. Click the customer with unpaid items.
3. Click **Send Payment Reminder**.
**Send in bulk:**
1. Navigate to the **Customers** page.
2. Filter by **Awaiting Payment**.
3. Select the customers you want to remind.
4. Click **Send Payment Reminders** from the bulk action bar.
> One reminder email can be sent per customer per 12-hour period.
***
## What the Reminder Includes
Each reminder email contains the customer's unpaid items and a direct link to their Ready for Checkout page.
***
## Customizing the Reminder Email
Open **Settings > Notifications**, click **Edit Templates**, then update the **Payment Reminder** template.
# Notification Types
Auction Plus sends automated email notifications to customers throughout the auction and offer process. There are 7 customer-facing notification types:
| Notification | When It's Sent |
| ------------------------- | ------------------------------------------------------ |
| **Auction Won** | A customer wins an auction |
| **Outbid** | Another bidder places a higher bid |
| **Offer Accepted** | You accept a customer's offer |
| **Offer Declined** | You decline a customer's offer |
| **Offer Received** | You initiate an offer on a product for a customer |
| **Counteroffer Received** | You respond to a customer's offer with a counter |
| **Payment Reminder** | A customer with unpaid items hasn't completed checkout |
Each notification type can be enabled or disabled individually. Open **Settings > Notifications**, then click **Edit Templates** in the **Email** section to manage them.
For configuring automatic payment reminders, see [How Checkout Works](/customers-and-bidders/payment-reminders).
# Customizing Email Templates
You can customize the content of each notification to match your brand voice.
1. Open **Settings > Notifications**.
2. In the **Email** section, click **Edit Templates**.
3. Select the notification tab you want to edit (e.g., Auction Won, Outbid).
4. Edit the available fields:
* **Subject line** — What customers see in their inbox
* **Heading** — The main headline inside the email
* **Subheading** — A secondary line below the heading
* **Message body** — The main content
* **Button text** — Label on the call-to-action button (e.g., "Complete Purchase")
5. Click **Save**.
***
## Using Variables
Insert dynamic content using Liquid syntax. Type `{{` in any text field to see a dropdown of available variables for that template. Variables are automatically replaced with real data when the email is sent.
***
## Previewing Emails
Click **Update Preview** in the template editor to review the layout before saving.
***
## Resetting to Defaults
Click **Reset to Defaults** on any notification type to restore the original template text. Resets apply per notification type only.
***
## Translations
Click **Show Translateable Fields** to view and edit translations for each template, allowing you to customize preset text in your preferred language.
# Uploading Your Logo
Your store logo appears at the top of every email Auction Plus sends.
***
## Step 1: Upload or locate your logo in Shopify
In your Shopify admin, navigate to **Content > Files**. Click **Upload Files** to upload a new logo, or select an existing logo from the list. Copy the file URL.
 
***
## Step 2: Add the logo URL to Auction Plus
1. Open **Settings > Notifications**.
2. In the **Email** section, click **Edit Templates**.
3. Find the **Shop Logo** field.
4. Paste the URL you copied from Shopify Files.
5. Click **Save**.
Your logo will now appear at the top of all outbound email notifications.
# Admin Email Notifications
Control which notifications you receive as a merchant. Open **Settings > Notifications**, then review the **Admin Notifications** card.
***
## Available Admin Notifications
* **Offer Received** — Notifies you when a customer submits an offer.
* **Counter-offer Received** — Notifies you when a customer counters your offer.
Admin notifications are sent to your store's contact email address.
# Custom Sender Domain
Send auction emails from your own domain instead of the default Auction Plus address. This gives your emails a professional, branded appearance.
> **Note:** Custom sender domains are available on the **Grow plan and above**. See [Plans](https://admin.shopify.com/apps/auction-plus/plans) for details on upgrading.
## Why Use a Custom Sender Domain?
* **Professional branding** — Emails come from an address like `auctions@yourdomain.com` instead of a generic address
* **Consistent customer experience** — Your customers see your brand at every touchpoint
## Setup Steps
### 1. Enter Your Custom Email Address
1. Open **Settings > Notifications**
2. In the **Email** section, update **Sender Email**
3. Enter your desired sender email address (e.g., `auctions@yourdomain.com`)
### 2. Add DNS Records
You will need to add two DNS records to your domain. Auction Plus will provide the exact values for each record.
**DKIM Record:**
* Type: TXT
* Add this record to your domain's DNS settings
* This authenticates your emails and prevents spoofing
**Return Path Record:**
* Type: CNAME
* Add this record to your domain's DNS settings
* This ensures bounced emails are handled correctly
> **Tip:** If you are unsure how to add DNS records, check your domain registrar's help documentation. You can typically add DNS records through the account where you registered your domain.
### 3. Verify Your Domain
1. After adding the DNS records, return to **Settings > Notifications**
2. Click **Verify DNS Records**
3. Auction Plus will check that your DNS records are correctly configured
4. Once verified, all outgoing emails will be sent from your custom address
> **Note:** DNS changes typically take effect within a few hours, but can take up to 48 hours to fully propagate. If verification fails, wait and try again later.
## Related
* [Notification Types](/email-and-notifications/notification-types)
* [Customizing Email Templates](/email-and-notifications/customizing-email-templates)
* [Uploading Your Logo](/email-and-notifications/uploading-your-logo)
* [Admin Email Notifications](/email-and-notifications/admin-email-notifications)
# Klaviyo Integration
The Klaviyo integration connects Auction Plus to your Klaviyo account, allowing you to send auction and offer events directly to Klaviyo for email and SMS marketing automation. Build targeted flows, segment customers by bidding behavior, and create personalized follow-ups -- all powered by real-time event data from your auctions.
> **Note:** The Klaviyo integration is available on the Grow plan and above. See [Available Plans](https://admin.shopify.com/apps/auction-plus/plans) for details.
***
## Setting Up the Integration
1. Navigate to **Settings > Integrations** in your Auction Plus dashboard.
2. Click **Connect Klaviyo**.
3. A new tab will open where you'll be asked to authorize the connection in your Klaviyo account.
4. Grant Auction Plus permission to send events to Klaviyo.
5. Return to the Auction Plus tab -- the connection status should now show **Connected**.
That's it. Once connected, Auction Plus will begin sending events to Klaviyo based on your configuration.
> Note: You may see a message indicating the app has not been reviewed by Klaviyo. This is expected as our integration is not listed on Klaviyo's public app directory.
***
## Tracked Events
Auction Plus can send the following events to Klaviyo. Each event can be individually enabled or disabled so you only receive the data you need.
### Auction Events
* **Bid Placed** -- Triggered when a customer places a bid on an auction. Includes the product, bid amount, and customer details.
* **Outbid** -- Triggered when a customer is outbid by another bidder. Useful for re-engagement campaigns.
* **Auction Won** -- Triggered when a customer wins an auction. Includes the winning price and product details.
### Offer Events
* **Offer Received** -- Triggered when a customer receives an offer.
* **Counteroffer Received** -- Triggered when a customer receives a counteroffer.
* **Offer Accepted** -- Triggered when an offer is accepted by either party.
* **Offer Declined** -- Triggered when an offer is declined by either party.
***
## Configuring Events
To choose which events are sent to Klaviyo:
1. Navigate to **Settings > Integrations > Klaviyo**.
2. You'll see a list of all available events with toggle switches.
3. Turn each event on or off based on your marketing needs.
4. Click **Save**.
Changes take effect immediately -- newly toggled events will start (or stop) flowing to Klaviyo right away.
***
## Disconnecting Klaviyo
If you need to disconnect the integration:
1. Go to **Settings > Integrations > Klaviyo**.
2. Click **Disconnect**.
3. Confirm the disconnection.
No further events will be sent to Klaviyo after disconnecting. Your existing Klaviyo data and flows will not be affected.
***
## Next Steps
* Set up SMS in Klaviyo by following the [Set Up SMS in Klaviyo](/integrations/set-up-sms-in-klaviyo) guide.
* Build an automated alert with [Set Up Outbid SMS Notifications in Klaviyo](/integrations/set-up-outbid-sms-notifications-in-klaviyo).
* See the full [Klaviyo Event Reference](/integrations/klaviyo-events) for all properties sent with each event -- useful when building Klaviyo flows and email templates.
* Learn more about automating your auction workflows in [Global Auction Settings](/auctions/global-auction-settings#automations).
* Set up offer rules to work alongside your Klaviyo flows in [Offer Rules](/offers/offer-rules).
# Klaviyo Event Reference
This page documents all event properties sent to Klaviyo by Auction Plus. Use these properties when building Klaviyo flows, segments, and email/SMS templates.
For setup instructions, see the [Klaviyo Integration](/integrations/klaviyo) page.
***
## Customer Profile
Every event includes the following customer profile data:
| Property | Description | Example |
| --------------------- | ---------------------------------------- | ------------------ |
| `email` | The customer's email address | `jane@example.com` |
| `Auction Plus Status` | Whether the customer is active or banned | `active` |
***
## Auction Events
### Bid Placed
Triggered when the high bid for an auction listing is updated.
```json
{
"shop": {
"name": "My Store",
"logo": "https://cdn.shopify.com/s/files/1/example/logo.png"
},
"auction": {
"uid": "34dhchwby12yzfhgk6d6t86e3c",
"total_bids": 12,
"ends_at": "2026-03-10T18:00:00+00:00"
},
"high_bid": {
"amount": {
"display": "$150.00",
"value": "15000",
"currency": "USD"
},
"automatic": false
},
"product": {
"id": 8045243138239,
"title": "Vintage Watch",
"url": "https://my-store.myshopify.com/products/vintage-watch",
"photo_url": "https://cdn.shopify.com/s/files/1/example/product.png"
}
}
```
| Property | Description |
| -------------------------- | --------------------------------------------------------------------------------- |
| `shop.name` | Your shop's display name |
| `shop.logo` | URL to your shop logo (null if not set) |
| `auction.uid` | Unique auction identifier |
| `auction.total_bids` | Total number of bids on the auction |
| `auction.ends_at` | Auction end date/time (ISO 8601) |
| `high_bid.amount.display` | Formatted display price of the current high bid |
| `high_bid.amount.value` | Numeric value of the current high bid (in the smallest currency unit, e.g. cents) |
| `high_bid.amount.currency` | Currency code |
| `high_bid.automatic` | Whether this bid was placed automatically via proxy bidding |
| `product.id` | Shopify product ID |
| `product.title` | Auction/product title |
| `product.url` | Storefront URL for the product |
| `product.photo_url` | URL to the product image (null if not set) |
> **Note:** `high_bid.automatic` is `false` for the initial bid placed when a customer enters their maximum bid. Subsequent automatic (proxy) bids triggered by other bidders will have `high_bid.automatic` set to `true`. Use this property to differentiate between manual and automatic bids in your Klaviyo flows.
### Outbid
Triggered when a customer is outbid by another bidder.
```json
{
"shop": {
"name": "My Store",
"logo": null
},
"auction": {
"uid": "34dhchwby12yzfhgk6d6t86e3c",
"total_bids": 13,
"ends_at": "2026-03-10T18:00:00+00:00"
},
"high_bid": {
"amount": {
"display": "$175.00",
"value": "17500",
"currency": "USD"
}
},
"product": {
"id": 8045243138239,
"title": "Vintage Watch",
"url": "https://my-store.myshopify.com/products/vintage-watch",
"photo_url": "https://cdn.shopify.com/s/files/1/example/product.png"
}
}
```
| Property | Description |
| -------------------------- | ----------------------------------------------------------------------------- |
| `shop.name` | Your shop's display name |
| `shop.logo` | URL to your shop logo (null if not set) |
| `auction.uid` | Unique auction identifier |
| `auction.total_bids` | Total number of bids on the auction |
| `auction.ends_at` | Auction end date/time (ISO 8601) |
| `high_bid.amount.display` | Formatted display price of the new high bid |
| `high_bid.amount.value` | Numeric value of the new high bid (in the smallest currency unit, e.g. cents) |
| `high_bid.amount.currency` | Currency code |
| `product.id` | Shopify product ID |
| `product.title` | Auction/product title |
| `product.url` | Storefront URL for the product |
| `product.photo_url` | URL to the product image (null if not set) |
### Auction Won
Triggered when a customer wins an auction.
```json
{
"shop": {
"name": "My Store",
"logo": null
},
"auction": {
"uid": "34dhchwby12yzfhgk6d6t86e3c",
"total_bids": 15,
"ends_at": "2026-03-10T18:00:00+00:00"
},
"winner": {
"amount": {
"display": "$200.00",
"value": "20000",
"currency": "USD"
}
},
"product": {
"id": 8045243138239,
"title": "Vintage Watch",
"url": "https://my-store.myshopify.com/products/vintage-watch",
"photo_url": "https://cdn.shopify.com/s/files/1/example/product.png"
},
"payment_url": "https://my-store.myshopify.com/apps/auction-plus/purchases"
}
```
| Property | Description |
| ------------------------ | ---------------------------------------------------------------------------- |
| `shop.name` | Your shop's display name |
| `shop.logo` | URL to your shop logo (null if not set) |
| `auction.uid` | Unique auction identifier |
| `auction.total_bids` | Total number of bids on the auction |
| `auction.ends_at` | Auction end date/time (ISO 8601) |
| `winner.amount.display` | Formatted display price of the winning bid |
| `winner.amount.value` | Numeric value of the winning bid (in the smallest currency unit, e.g. cents) |
| `winner.amount.currency` | Currency code |
| `product.id` | Shopify product ID |
| `product.title` | Auction/product title |
| `product.url` | Storefront URL for the product |
| `product.photo_url` | URL to the product image (null if not set) |
| `payment_url` | Direct link to the customer's checkout page |
***
## Offer Events
All four offer events -- Offer Received, Counteroffer Received, Offer Accepted, and Offer Declined -- share the same properties.
```json
{
"shop": {
"name": "My Store",
"logo": null
},
"offer": {
"uid": "tgyt6dwq3537bbr9xbcw09509c",
"expires_at": "2026-03-07T19:19:04+00:00",
"amount": {
"display": "$95.00",
"value": "9500",
"currency": "USD"
},
"message": null,
"is_seller": true
},
"product": {
"id": 8045243138239,
"photo_url": null
},
"variant": {
"id": 43973168332991,
"url": "https://my-store.myshopify.com/products/title?variant=43973168332991",
"display_name": "Offer Test"
},
"offers_url": "https://my-store.myshopify.com/apps/auction-plus/offers"
}
```
| Property | Description |
| ----------------------- | ---------------------------------------------------------------------- |
| `shop.name` | Your shop's display name |
| `shop.logo` | URL to your shop logo (null if not set) |
| `offer.uid` | Unique offer identifier |
| `offer.expires_at` | Offer expiration date/time (ISO 8601) |
| `offer.amount.display` | Formatted display price of the offer |
| `offer.amount.value` | Numeric value of the offer (in the smallest currency unit, e.g. cents) |
| `offer.amount.currency` | Currency code |
| `offer.message` | Message included with the offer (null if none) |
| `offer.is_seller` | Whether this offer was made by the seller |
| `product.id` | Shopify product ID |
| `product.photo_url` | URL to the product image (null if not set) |
| `variant.id` | Shopify variant ID |
| `variant.url` | Storefront URL for the variant |
| `variant.display_name` | Display name of the variant |
| `offers_url` | Direct link to the customer's offers page |
# Set Up SMS in Klaviyo
Enable SMS in Klaviyo so you can send Auction Plus notifications by text.
Auction Plus can send events to Klaviyo, but SMS sending is configured in Klaviyo itself.
Before you start:
* Connect the [Klaviyo Integration](/integrations/klaviyo).
* Complete Klaviyo's SMS setup before building flows.
* Enable [bidder registration](/customers-and-bidders/bidder-registration-and-approval) to collect customer phone numbers.
***
## Set up SMS in Klaviyo
Follow Klaviyo's official guide to enable SMS for your account:
[Getting started with SMS for new senders](https://help.klaviyo.com/hc/en-us/articles/4404274419355)
Klaviyo walks you through:
* enabling SMS for your account
* choosing your sending number
* completing any required compliance steps
***
## Next steps
After SMS is enabled in Klaviyo, you can start building Auction Plus text notifications.
Recommended next steps:
* Build an automated outbid flow with [Set Up Outbid SMS Notifications in Klaviyo](/integrations/set-up-outbid-sms-notifications-in-klaviyo).
* Review available event fields in [Klaviyo Event Reference](/integrations/klaviyo-events).
{% hint style="info" %}
SMS setup happens in Klaviyo. Auction Plus provides the event data you use in Klaviyo flows.
{% endhint %}
# Set Up Outbid SMS Notifications in Klaviyo
Build an automated Klaviyo SMS flow that sends when a bidder is outbid.
Use an SMS flow when you want Klaviyo to send a message automatically after an outbid event.
Before you start:
* Connect the [Klaviyo Integration](/integrations/klaviyo).
* Complete [Klaviyo's SMS setup](/integrations/set-up-sms-in-klaviyo) before building flows.
* Enable [bidder registration](/customers-and-bidders/bidder-registration-and-approval) to collect customer phone numbers.
{% hint style="info" %}
To activate bidder registration, visit the **Settings > Auction** page and scroll to the **Registration & Verification** section. Select **Auction Participants > All registered customers** and check the **SMS marketing consent** field under **Registration fields**.
{% endhint %}
**Syncing the Outbid notification to Klaviyo**
For events to appear in Klaviyo, they must first occur in Auction Plus. If you have not run an auction since you first connected your Klaviyo account, you'll need to create a test auction listing. Place a bid with one account. Then place a higher bid with another account. This sends the **Outbid** event to Klaviyo so you can use it in a flow.
> Note: This step can be skipped if you've already run an auction with competing bids since you first connected Klaviyo.
***
## Create the flow
1. Open **Flows** in Klaviyo.
2. Click **Create flow >** **Build your own**.
3. Select **Your Metrics**.\
4. Choose **Auction Plus > Outbid**.
5. Click **Save**.
6. Click **Confirm and Save** if Klaviyo shows a confirmation modal.
***
## Add the text message action
1. Drag and drop **Text message** from the left sidebar to the trigger on the canvas.
2. Open the SMS step settings.\
3. Leave **Enable Text message quiet hours** turned on.
You can also add flow filters. This helps limit how often the same person gets a text.
Example filter:
* **Has not received this SMS** in the last **1 hour**.
***
## Set your message
Click **Edit** in the content section. Then paste this message:
```
You've been outbid on {{ event.product.title|default:'' }}! Try placing a higher bid {{ event.product.url|default:'' }}
```
You can click **Preview & test** to preview and send a test message with sample data. Click **Next** when you are ready to continue.
***
## Review and turn on the flow
1. Review quiet hours and any flow filters you have added.
2. Apply your changes by clicking **Review and turn on.**
3. Follow the steps to activate your flow.
{% hint style="info" %}
Use the [Klaviyo Event Reference](/integrations/klaviyo-events) if you want to inspect the event fields available in this flow.
{% endhint %}
If you need help with advanced flow behavior, contact Klaviyo support for additional assistance.
# Set Up Payment SMS Notifications in Klaviyo
Build an automated Klaviyo SMS flow that sends payment reminders from the Auction Won event.
Use an SMS flow when you want Klaviyo to send a payment reminder after an **Auction Won** event.
Before you start:
* Connect the [Klaviyo Integration](/integrations/klaviyo).
* Complete [Klaviyo's SMS setup](/integrations/set-up-sms-in-klaviyo) before building flows.
* Enable [bidder registration](/customers-and-bidders/bidder-registration-and-approval) to collect customer phone numbers.
{% hint style="info" %}
To activate bidder registration, visit the **Settings > Auction** page and scroll to the **Registration & Verification** section. Select **Auction Participants > All registered customers** and check the **SMS marketing consent** field under **Registration fields**.
{% endhint %}
**Syncing the Auction Won event to Klaviyo**
For events to appear in Klaviyo, they must first occur in Auction Plus. If no customer has won an auction since you first connected your Klaviyo account, create a test auction, place a bid, then end the listing. This sends the **Auction Won** event to Klaviyo so you can use it in a flow.
> Note: This step can be skipped if an auction listing has already been won since you first connected Klaviyo.
***
## Create the flow
1. Open **Flows** in Klaviyo.
2. Click **Create flow >** **Build your own**.
3. Select **Your Metrics**.\
4. Choose **Auction Plus > Auction Won**.
5. Set the re-entry criteria to **Allow re-entry after a time period** for at least 1 hour. This helps avoid sending too many SMS messages when a customer wins multiple items at once.\
6. Click **Save**.
7. Click **Confirm and Save** if Klaviyo shows a confirmation modal.
***
## Add the text message action
1. Drag and drop **Text message** from the left sidebar to the trigger on the canvas.
2. The text message details will appears on the left\
3. Leave **Enable Text message quiet hours** turned on.
***
## Set your message
Click **Edit** in the content section. Then paste this message:
```
You won {{ event.product.title|default:'' }} for {{ event.winner.amount.display|default:'' }}! Complete your payment {{ event.payment_url|default:'' }}
```
You can click **Preview & test** to preview and send a test message with sample data. Click **Next** when you are ready to continue.
***
## Review and turn on the flow
1. Review quiet hours and any flow filters you have added.
2. Apply your changes by clicking **Review and turn on.**
3. Follow the steps to activate your flow.
If you need help with advanced flow behavior, contact Klaviyo support for additional assistance.
{% hint style="info" %}
Use the [Klaviyo Event Reference](/integrations/klaviyo-events) if you want to inspect the event fields available in this flow.
{% endhint %}
# Analytics Dashboard
Use Analytics to review gross sales, order trends, and auction revenue over a selected date range.
## How to Open Analytics
You can open the Analytics page from the dashboard by clicking **View Analytics** in the gross sales section.
## What You Can Review
The page includes:
* Summary cards for the selected range
* Trend charts over time
* Gross sales, order, and auction revenue reporting
## Date Ranges
You can choose:
* Preset ranges such as the last 7, 30, or 90 days
* A custom start and end date
## Chart Intervals
Auction Plus automatically changes chart grouping based on the selected range:
* Up to 3 days: hourly
* Up to 3 months: daily
* More than 3 months: monthly
## If Analytics Is Unavailable
Analytics access depends on your current plan. Review your options on the [Plans and Billing](https://admin.shopify.com/apps/auction-plus/plans) page.
# Plans and Billing
The [Plans & Billing](https://admin.shopify.com/apps/auction-plus/plans) page in Auction Plus lists current pricing, feature limits, and upgrade options.
All paid plans include a 7-day free trial for new subscribers.
***
## Downgrading to the Free Plan
To downgrade to the Free plan:
1. Open the [Plans & Billing](https://admin.shopify.com/apps/auction-plus/plans) page.
2. Press the **Get Started** button under the free plan section.
The downgrade will take effect at the end of your current billing cycle.
***
## Billing Cycles & Shopify Invoicing
All billing for Auction Plus is managed by Shopify. There are two billing cycles to be aware of:
* **App billing cycle** -- Auction Plus runs on its own 30-day billing cycle, starting after your free trial ends.
* **Shopify billing cycle** -- Shopify collects all app charges and bills them together on your store's billing date.
Because these two cycles are independent, there is often a delay between when an app charge is incurred and when it appears on your Shopify invoice.
If you see a charge after canceling your plan, this is due to the separate billing cycles. It reflects your final period of service that had not yet been billed, and is not a duplicate charge or a charge for a new billing period.
For more information on how billing works for Shopify apps, see [Shopify's Billing Documentation](https://help.shopify.com/en/manual/your-account/manage-billing/billing-charges/types-of-charges/third-party-charges/app-charges).
# Multi-Language Support
Auction Plus supports multiple languages and custom translations for app text on your storefront.
> **Note:** Multi-language support is available on all paid plans. The Free plan supports your store's primary language.
***
## How It Works
Auction Plus pulls its language list directly from your Shopify store settings. Here's the setup process:
1. **Add languages in Shopify** -- Go to your Shopify admin and navigate to **Settings > Languages**. Add any languages you want to support.
2. **Open Auction Plus translations** -- In your Auction Plus dashboard, navigate to **Settings > Translations**.
3. **View available languages** -- Any languages you've added in Shopify will automatically appear here.
4. **Enable translations** -- Toggle each language on or off as needed.
5. **Edit translations** -- Customize the text for each language to match your brand voice.
> Storefront text for the following languages can be automatically translated from English: German, Spanish, French, Italian, Norwegian Bokmål, and Dutch. Please review these translations for accuracy before publishing.
***
## Customizing Translations
Once you've added a language in your Shopify settings, you can customize the translations for that language in Auction Plus:
1. Navigate to **Settings > Translations** in your Auction Plus dashboard.
2. Select the language you want to edit.
3. Review each field and enter your translated text.
4. Click **Save** when you're done.
***
## Next Steps
* Customize your email notification templates per language in [Customizing Email Templates](/email-and-notifications/customizing-email-templates).
* Learn about auction behavior settings in [Auction Settings](/auctions/auction-listing-settings).
# Common Issues
## Auction Does Not Appear on the Product Page
Check these first:
1. The [app embed](/storefront-setup/theme-setup) is enabled
2. The [Auction block](/storefront-setup/adding-auction-block) was added to the correct product template
3. The auction is active or scheduled correctly
4. The product is using the expected Shopify template
## Follow or Offer Button Does Not Appear
Check these first:
1. The app embed is enabled
2. The correct app block was added in the theme editor
3. The feature is enabled in Auction Plus
4. For offers, an active [offer rule](/offers/offer-rules) matches the product
## Auction Cards Not Showing on Custom Pages
Auction Plus automatically displays the auction countdown on product cards on Shopify collection templates. However, if you are using a custom "page" template, auction cards will not appear by default.
To resolve this:
* Use a collection template instead of a custom page template to display auction listings.
* If you need a custom page, contact `support@auctionplusapp.com` or use the in-app chat for help adding the required code snippet to your theme.
See [Theme Setup](/storefront-setup/theme-setup) and [Adding the Auction Block](/storefront-setup/adding-auction-block) for more on theme configuration.
## Winner Cannot Complete Checkout
If a winner clicks the checkout link and cannot complete their purchase, the most common cause is **missing inventory**. The underlying Shopify product must have inventory available at your store's default location.
To fix this:
1. Open the product in your Shopify admin.
2. Check that the inventory quantity is at least 1 at your default location.
3. Ask the winner to try again.
See [How Checkout Works](/products-and-checkout/get-started-with-orders-and-checkout) for the full checkout flow.
## Customer Cannot Find the Checkout Page
Customers can reach checkout by clicking the payment button from the winner email or accepted-offer email. If the customer still needs help finding the checkout page, you can:
1. Send a payment reminder from the **Customers** page, or share the direct path: `https://yourstore.com/apps/auction-plus`
2. Add the link to customer accounts by following [Adding an Auctions Link to Customer Accounts](/customers-and-bidders/adding-an-auctions-link-to-customer-accounts)
## Customer Sees the Wrong Price at Checkout
For auctions:
* Check whether another app, workflow, or staff member changed the Shopify product price after the auction ended
* Confirm the customer is not simply viewing a converted local currency
For offers:
* Confirm the Auction Plus offer discount is listed in Shopify on the Discounts admin page
* If the offer product also contains a [product fee](/products-and-checkout/product-fees-and-buyers-premium), make sure the fee product was not deleted in Shopify's products section
* Confirm the customer is not simply viewing a converted local currency
## Email Passcode
Auction Plus does not require a passcode to place bids. If a customer reports being asked for a passcode, this is Shopify's customer account login flow — not an Auction Plus requirement.
Consider advising the customer to check their spam or junk folder for the login email from Shopify, or contact Shopify support for assistance.
## Order Tags
When a winner completes checkout, the Shopify order is automatically tagged based on the transaction type:
* `auction` — for orders containing auction wins.
* `offer` — for orders from the Make an Offer feature.
If the order is not tagged, the customer likely checked out with a different email or account than the one they used to bid.
## Store Currency Changes
Auction Plus uses the store currency set in your Shopify settings at the time of installation. If you change your store currency:
1. Ensure there are no active auctions.
2. Contact `support@auctionplusapp.com` or use the in-app chat to update the app's currency to match your new store currency.
## Need More Help?
Email `support@auctionplusapp.com` or use the in-app chat.
# FAQ
Answers to frequently asked questions from Auction Plus merchants.
## Auctions
**Q: How do I display the auction countdown on my collection pages?**
Auction Plus automatically adds a countdown timer to product cards on collection pages when the [app embed](/storefront-setup/theme-setup) is enabled. Some themes, such as Horizon or Savor, support adding the Auction Countdown app block directly on your product cards. If you are unable to add the countdown timer to your collection pages, please contact support for assistance.
**Q: Can I run multiple auctions on the same product?**
No. Only one active auction per product at a time. Cancel the existing auction or wait for it to end before creating a new one.
**Q: What happens with product variants?**
Auction Plus uses only the first variant. If your product has multiple variants, only the first is auctioned. Use single-variant products for auctions whenever possible.
**Q: How does the reserve price work?**
The reserve price is a hidden minimum. If bidding doesn't reach it, no winner is declared. When a proxy bid meets or exceeds the reserve, the displayed bid automatically jumps to the reserve price.
The reserve price can be changed at any time before the first bid is placed. After a bid has been placed, it can only be changed if a reserve is already set, the reserve has not been met, and the new reserve is higher than the current high bid.
**Q: What happens when I reach my auction limit?**
You can't create new auctions until your billing period resets or you upgrade your plan. Existing active auctions continue normally.
**Q: Can customers bid without a Shopify account?**
No. Customers must have a Shopify customer account to place bids.
**Q: How does soft close (popcorn bidding) work?**
Soft close automatically extends the auction end time when a bid is placed in the configured final window (e.g., the last 2 minutes). This prevents last-second sniping to give other bidders a fair chance to respond. See [Auction Settings](/auctions/auction-listing-settings#soft-close-anti-sniping).
**Q: What is automatic bidding?**
Customers enter the maximum they're willing to pay. The system bids on their behalf using the minimum increment needed to stay in the lead — up to their maximum. Other bidders only see the current high bid, not the hidden maximum. See [Auction Settings](/auctions/auction-listing-settings#proxy-bidding-automatic-bids).
**Q: Why do multiple bids show the same timestamp?**
When automatic bidding is active, multiple bids placed by the system on a bidder's behalf can show the same timestamp. This is expected behavior — the system shows the timestamp of the original bid that triggered the auto-bids, not the time the proxy bids were placed.
**Q: How do payment reminders work?**
You can send payment reminders to winners who have not yet completed checkout from the **Awaiting Payment** tab under the Customers section. Select customers and click **Send Payment Reminder**. Reminders are limited to one per 12-hour period per customer. You can also configure automatic payment reminders from the Settings page. See [Payment Reminders](/customers-and-bidders/payment-reminders).
**Q: How do I handle a non-paying winner?**
Consider configuring automatic payment reminders for winning bidders. If the customer still does not pay, the winner can be canceled from the auction detail page. You can then send a second-chance offer to another bidder from the Top Bidders section. Consider banning customers who do not pay from bidding on future auctions. See [Managing Winners and Second-Chance Offers](/auctions/managing-winners-and-second-chance-offers) and [Banning Customers](/customers-and-bidders/banning-customers).
**Q: Do I need to add my existing Shopify customers to Auction Plus?**
No. Customers are synced automatically from Shopify when they interact with your auctions — for example, when they place a bid or register to bid. Any existing Shopify customer can bid on your auctions as long as they have a customer account and meet any approval requirements you have configured.
**Q: How do outbid email notifications work?**
Outbid notifications are included on all paid plans and are automatically enabled. When a bidder is outbid, they receive an email notification. You can customize the email content under **Settings > Notifications**. Bid and outbid notifications are sent to bidders only — store administrators do not receive these notifications.
***
## Offers
**Q: Can I use offers and auctions on the same product?**
Yes. Customers can submit offers before the first bid is placed on an auction. Once bidding begins, the offer option is removed.
**Q: Why is the Make Offer button missing on a product?**
The Make Offer button only appears on products with an active offer rule that applies to that product. Please create an offer rule set to active, ensure the app embed is enabled on your storefront, and the Make Offer button has been added to your product page. See [Get Started with Offers](/offers/get-started-with-offers).
***
## Emails
**Q: Can I customize the auction emails?**
Yes. You can customize email templates and set up a custom sender domain. See [Customizing Email Templates](/email-and-notifications/customizing-email-templates) and [Custom Sender Domain](/email-and-notifications/custom-sender-email-domain).
***
## Billing & Plans
**Q: What currencies are supported?**
Bids are always placed in your store's default currency to avoid exchange rate fluctuations between bidding and checkout. If your store supports multiple currencies, the winner can check out in their preferred currency after the auction ends.
The currency of your store at the time of install is used for bidding. If you change your store's default currency after installing Auction Plus, contact support to update your bidding currency.
**Q: Can I change my plan mid-cycle?**
Yes. Upgrades take effect immediately with prorated billing. Downgrades take effect at the start of your next billing period.
**Q: Is there a free trial?**
Yes. All paid plans include a 7-day free trial.
**Q: How do I downgrade to the free plan?**
Go to the **Plans** page and click **Get Started** under the Free plan. Uninstalling the app will also cancel your current plan automatically.
***
## Translations & Settings
**Q: How do I translate storefront text?**
Navigate to **Settings > Translations**. From there you can translate all customer-facing text displayed by Auction Plus on your storefront.
***
## Compatibility
**Q: Can I use Auction Plus with other Shopify apps?**
Yes, Auction Plus works alongside most Shopify apps. Some apps may conflict with auction purchase restrictions, especially apps that inject extra purchase buttons or product actions. See [Restricting Purchases](/products-and-checkout/restricting-purchases-for-auction-products).
**Q: Does Auction Plus work with my Shopify theme?**
Auction Plus works with most Shopify themes. If your theme does not support one of our app blocks, contact `support@auctionplusapp.com` for assistance.
***
## Getting Help
* **Email:** `support@auctionplusapp.com`
* **In-app chat:** Open the chat widget from your Auction Plus dashboard
# Getting Started
Use this guide to send your first authenticated request to the Auction Plus REST API. It covers authentication, request structure, response structure, and the basics of rate limiting.
## Before you start
You need:
* Auction Plus installed in Shopify
* Access to **Settings** → **API**
* A secure server-side environment for your token
## Base URL
Send all requests to:
```
https://api.auctionplusapp.com/v1
```
## Authentication
The API uses bearer token authentication.
### Generate an API token
1. Open Auction Plus in Shopify.
2. Go to **Settings**.
3. Open **API**.
4. Click **Generate Private Token**.
Store the token securely. It is only shown once.
### Send the token in the `Authorization` header
Include these headers with every request:
```http
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json
```
If the token is missing or invalid, the API returns `401 Unauthorized`.
## Make your first request
Use the auction items endpoint to test your connection.
{% code title="cURL" %}
```bash
curl --request GET \
--url https://api.auctionplusapp.com/v1/auction-items \
--header "Authorization: Bearer YOUR_API_TOKEN" \
--header "Accept: application/json"
```
{% endcode %}
A successful request returns a `data` object or array. List endpoints may also return pagination details in `meta`.
## Response format
Most endpoints return a resource-based JSON payload:
```json
{
"data": [
{
"id": "34dhchwby12yzfhgk6d6t86e3c",
"type": "auction-items",
"attributes": {
"status": "active",
"totalBids": 12
}
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 25,
"total": 1
}
}
```
### Common response fields
| Field | Description |
| ------------ | --------------------------------- |
| `data` | Primary resource or resource list |
| `id` | Resource identifier |
| `type` | Resource type |
| `attributes` | Resource fields |
| `meta` | Pagination or response metadata |
## Common request patterns
The API follows standard REST conventions:
* `GET` retrieves resources
* `POST` creates resources when supported
* `PATCH` updates resources or triggers actions
Many endpoints also support filtering, sorting, sparse fieldsets, and related resources.
### Common query parameters
| Parameter | Description |
| ----------------------- | ------------------------------------ |
| `include` | Include related resources |
| `sort` | Sort by a supported field |
| `perPage` | Set the page size for list endpoints |
| `fields[resource-type]` | Return only selected fields |
| `filter[...]` | Filter supported endpoints |
## Common endpoints
Start with these auction item endpoints:
* `GET /auction-items` — List auction items
* `GET /auction-items/{id}` — Retrieve one auction item
* `PATCH /auction-items/{id}/end` — End a listing early
* `PATCH /auction-items/{id}/cancel` — Cancel a listing without assigning a winner
See [Auction Items](broken://spaces/sQVmXQ0YPLAOjdunzCT9/pages/6348f96fce73c7df47bf23384fdcbb05cd3fef80) for full request and response schemas.
## Error handling
Use the HTTP status code first. Then inspect the response body.
| Status code | Meaning |
| -------------------------- | ----------------------------------------------------------- |
| `200 OK` | Request succeeded |
| `401 Unauthorized` | Token is missing, expired, or invalid |
| `404 Not Found` | The resource does not exist |
| `422 Unprocessable Entity` | The request body is valid JSON but invalid for the endpoint |
| `429 Too Many Requests` | Rate limit exceeded |
## Rate limits
The API applies request limits to each authenticated user.
If you exceed the limit, the API returns `429 Too Many Requests`.
See [Rate Limiting](broken://spaces/sQVmXQ0YPLAOjdunzCT9/pages/bd0b854072afcdb55143d855a6d6aab9fcdfccc9) for bucket values, response headers, and retry guidance.
## Best practices
* Keep API tokens in trusted server-side environments
* Paginate large result sets
* Request only the fields and includes you need
# Rate Limiting
The API uses a leaky bucket algorithm to control request rates. Each authenticated user has a bucket with a capacity of **60 requests**. The bucket leaks at a rate of **4 requests per second**.
When a request is made, it is added to the bucket. If the bucket is full, the API responds with a `429 Too Many Requests` status.
#### Response Headers
Every response includes rate limit headers:
| Header | Description |
| ----------------------- | -------------------------------------------- |
| `X-RateLimit-Limit` | Maximum number of requests (bucket capacity) |
| `X-RateLimit-Remaining` | Number of requests remaining in the bucket |
When rate limited (429), additional headers are included:
| Header | Description |
| ------------------- | ------------------------------------- |
| `Retry-After` | Seconds to wait before retrying |
| `X-RateLimit-Reset` | Unix timestamp when the bucket resets |
# Auction Items
An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.
Price attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.
The **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.
The **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.
The **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time.
# List Auction Items
Returns a paginated list of auction items.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.\n\nPrice attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.\n\nThe **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"reservePrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"},"extendFrom":{"type":["integer","null"]},"extendDuration":{"type":["integer","null"]}},"required":["enabled","extendFrom","extendDuration"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string"},"reserveMet":{"type":"string"},"canceledAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"},"VariantResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"variants"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"displayName":{"type":"string"},"title":{"type":["string","null"]},"price":{"type":["integer","null"]},"photoUrl":{"type":["string","null"]},"sku":{"type":["string","null"]}}}},"required":["id","type"],"title":"VariantResource"},"ProductResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"products"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"title":{"type":"string"},"vendor":{"type":["string","null"]},"type":{"type":["string","null"]},"photoUrl":{"type":["string","null"]},"handle":{"type":["string","null"]}}}},"required":["id","type"],"title":"ProductResource"},"BidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"placedAt":{"type":["string","null"],"format":"date-time"},"automatic":{"type":["boolean","null"]}}}},"required":["id","type"],"title":"BidResource"},"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"},"AuctionWinnerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-winners"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"notifiedAt":{"type":["string","null"],"format":"date-time"},"paymentDueAt":{"type":["string","null"],"format":"date-time"},"paid":{"type":"boolean","description":"Whether the winning bid has been paid."},"externalOrderId":{"type":"string","description":"The Shopify order ID, present once the winner has paid."}}}},"required":["id","type"],"title":"AuctionWinnerResource"},"MaxBidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"max-bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"MaxBidResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items":{"get":{"operationId":"listAuctionItems","description":"Returns a paginated list of auction items.","summary":"List Auction Items","tags":["Auction Items"],"parameters":[{"name":"filter[status]","in":"query","schema":{"type":"string","enum":["active","scheduled","completed"]}},{"name":"filter[eventId]","in":"query","schema":{"type":"string"}},{"name":"perPage","in":"query","description":"Results per page (1–100).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `reservePrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `reserveMet`, `canceledAt`, `archivedAt`, `processed`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`, `sku`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`, `automatic`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-winners]","in":"query","description":"Available values are `amount`, `notifiedAt`, `paymentDueAt`, `paid`, `externalOrderId`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[max-bids]","in":"query","description":"Available values are `amount`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`, `highBid`, `highBid.customer`, `maxBid`, `winner`, `winner.customer`.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort by field. Prefix with `-` for descending order. Available values: `endsAt`, `-endsAt`, `totalBids`, `-totalBids`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated set of `AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}},"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"winner":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["auction-winners"]},"id":{"type":"string"}},"required":["type","id"]}}},"maxBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["max-bids"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]}},"meta":{"type":"object","properties":{"currentPage":{"type":"integer","minimum":1},"from":{"type":["integer","null"],"minimum":1},"lastPage":{"type":"integer","minimum":1},"perPage":{"type":"integer","description":"Number of items shown per page.","minimum":0},"to":{"type":["integer","null"],"description":"Number of the last item in the slice.","minimum":1},"total":{"type":"integer","description":"Total number of items being paginated.","minimum":0}},"required":["currentPage","from","lastPage","perPage","to","total"]},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/VariantResource"},{"$ref":"#/components/schemas/ProductResource"},{"$ref":"#/components/schemas/BidResource"},{"$ref":"#/components/schemas/CustomerResource"},{"$ref":"#/components/schemas/AuctionWinnerResource"},{"$ref":"#/components/schemas/MaxBidResource"}]}}},"required":["data","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
# Create an auction item
Creates a new auction listing for a product.
Prices are fixed amounts in the shop's currency. Omit `bidIncrement` to use the default tiered bid increment table.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.\n\nPrice attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.\n\nThe **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"reservePrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"},"extendFrom":{"type":["integer","null"]},"extendDuration":{"type":["integer","null"]}},"required":["enabled","extendFrom","extendDuration"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string"},"reserveMet":{"type":"string"},"canceledAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"},"VariantResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"variants"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"displayName":{"type":"string"},"title":{"type":["string","null"]},"price":{"type":["integer","null"]},"photoUrl":{"type":["string","null"]},"sku":{"type":["string","null"]}}}},"required":["id","type"],"title":"VariantResource"},"ProductResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"products"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"title":{"type":"string"},"vendor":{"type":["string","null"]},"type":{"type":["string","null"]},"photoUrl":{"type":["string","null"]},"handle":{"type":["string","null"]}}}},"required":["id","type"],"title":"ProductResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items":{"post":{"operationId":"createAuctionItem","description":"Creates a new auction listing for a product.\n\nPrices are fixed amounts in the shop's currency. Omit `bidIncrement` to use the default tiered bid increment table.","summary":"Create an auction item","tags":["Auction Items"],"parameters":[{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `reservePrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `reserveMet`, `canceledAt`, `archivedAt`, `processed`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`, `sku`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"externalProductId":{"type":"number","description":"The Shopify product ID"},"auctionEventId":{"type":["string","null"],"description":"The UID of an uncompleted auction event to add this item to. The event dictates the item's open and close times."},"startsAt":{"type":"string","format":"date-time","description":"The date and time the auction opens (ISO 8601). Required unless the item is added to an auction event."},"endsAt":{"type":"string","format":"date-time","description":"The date and time the auction closes (ISO 8601). Required unless the item is added to an auction event."},"startPrice":{"type":"number","description":"The starting price in major currency units (e.g. 10.50).","minimum":0.01},"reservePrice":{"type":["number","null"],"description":"The reserve price in major currency units. Must be greater than or equal to the start price.","minimum":0.01},"offerRuleId":{"type":["string","null"],"description":"The UID of an active auction offer rule to attach."},"productFeeId":{"type":["string","null"],"description":"The UID of an active auction product fee to attach."},"bidIncrementStrategy":{"type":"object","description":"How bids are incremented. Omit to use the default tiered increment table.","properties":{"strategy":{"type":"string","description":"The increment type.","enum":["fixed_amount","percentage","tier"]},"value":{"type":"object","properties":{"amount":{"type":"number","description":"The fixed increment in major currency units. Required when strategy is `fixed_amount`.","minimum":0.1},"percentage":{"type":"number","description":"The increment as a percentage of the current price. Required when strategy is `percentage`.","minimum":0.1,"maximum":100}}}}},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether customers may set a maximum (proxy) bid. Defaults to true."}}},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the auction is extended when a bid is placed near the end. Defaults to false."},"extendFrom":{"type":["integer","null"],"description":"Seconds before the end within which a bid triggers an extension.","minimum":1,"maximum":65535},"extendDuration":{"type":["integer","null"],"description":"Seconds the auction is extended by. Must be greater than or equal to extendFrom.","minimum":1,"maximum":65535}}}},"required":["externalProductId","startPrice"]}}}},"responses":{"201":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/VariantResource"},{"$ref":"#/components/schemas/ProductResource"}]}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"description":"You have reached your plan's auction listing limit.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"422":{"description":"Unprocessable entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}}}}}
```
# Retrieve an auction item
Retrieve the details for a single auction listing.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.\n\nPrice attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.\n\nThe **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"reservePrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"},"extendFrom":{"type":["integer","null"]},"extendDuration":{"type":["integer","null"]}},"required":["enabled","extendFrom","extendDuration"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string"},"reserveMet":{"type":"string"},"canceledAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"},"VariantResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"variants"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"displayName":{"type":"string"},"title":{"type":["string","null"]},"price":{"type":["integer","null"]},"photoUrl":{"type":["string","null"]},"sku":{"type":["string","null"]}}}},"required":["id","type"],"title":"VariantResource"},"ProductResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"products"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"title":{"type":"string"},"vendor":{"type":["string","null"]},"type":{"type":["string","null"]},"photoUrl":{"type":["string","null"]},"handle":{"type":["string","null"]}}}},"required":["id","type"],"title":"ProductResource"},"BidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"placedAt":{"type":["string","null"],"format":"date-time"},"automatic":{"type":["boolean","null"]}}}},"required":["id","type"],"title":"BidResource"},"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"},"AuctionWinnerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-winners"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"notifiedAt":{"type":["string","null"],"format":"date-time"},"paymentDueAt":{"type":["string","null"],"format":"date-time"},"paid":{"type":"boolean","description":"Whether the winning bid has been paid."},"externalOrderId":{"type":"string","description":"The Shopify order ID, present once the winner has paid."}}}},"required":["id","type"],"title":"AuctionWinnerResource"},"MaxBidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"max-bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"MaxBidResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items/{id}":{"get":{"operationId":"getAuctionItem","description":"Retrieve the details for a single auction listing.","summary":"Retrieve an auction item","tags":["Auction Items"],"parameters":[{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `reservePrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `reserveMet`, `canceledAt`, `archivedAt`, `processed`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`, `sku`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`, `automatic`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-winners]","in":"query","description":"Available values are `amount`, `notifiedAt`, `paymentDueAt`, `paid`, `externalOrderId`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[max-bids]","in":"query","description":"Available values are `amount`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The auction item ID.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`, `highBid`, `highBid.customer`, `maxBid`, `winner`, `winner.customer`.","schema":{"type":"string"}}],"responses":{"200":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}},"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"winner":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["auction-winners"]},"id":{"type":"string"}},"required":["type","id"]}}},"maxBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["max-bids"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/VariantResource"},{"$ref":"#/components/schemas/ProductResource"},{"$ref":"#/components/schemas/BidResource"},{"$ref":"#/components/schemas/CustomerResource"},{"$ref":"#/components/schemas/AuctionWinnerResource"},{"$ref":"#/components/schemas/MaxBidResource"}]}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
# Update an auction item
Updates an auction item. Only the fields you send are changed; omitted fields are left as-is.
The item must not be canceled or ended. Prices are fixed amounts in the shop's currency. For items that belong to an auction event, `startsAt`/`endsAt` are dictated by the event and should be omitted from the request.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.\n\nPrice attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.\n\nThe **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"reservePrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"},"extendFrom":{"type":["integer","null"]},"extendDuration":{"type":["integer","null"]}},"required":["enabled","extendFrom","extendDuration"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string"},"reserveMet":{"type":"string"},"canceledAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"},"VariantResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"variants"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"displayName":{"type":"string"},"title":{"type":["string","null"]},"price":{"type":["integer","null"]},"photoUrl":{"type":["string","null"]},"sku":{"type":["string","null"]}}}},"required":["id","type"],"title":"VariantResource"},"ProductResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"products"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"title":{"type":"string"},"vendor":{"type":["string","null"]},"type":{"type":["string","null"]},"photoUrl":{"type":["string","null"]},"handle":{"type":["string","null"]}}}},"required":["id","type"],"title":"ProductResource"},"BidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"placedAt":{"type":["string","null"],"format":"date-time"},"automatic":{"type":["boolean","null"]}}}},"required":["id","type"],"title":"BidResource"},"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"},"MaxBidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"max-bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"MaxBidResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items/{id}":{"patch":{"operationId":"updateAuctionItem","description":"Updates an auction item. Only the fields you send are changed; omitted fields are left as-is.\n\nThe item must not be canceled or ended. Prices are fixed amounts in the shop's currency. For items that belong to an auction event, `startsAt`/`endsAt` are dictated by the event and should be omitted from the request.","summary":"Update an auction item","tags":["Auction Items"],"parameters":[{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `reservePrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `reserveMet`, `canceledAt`, `archivedAt`, `processed`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`, `sku`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`, `automatic`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[max-bids]","in":"query","description":"Available values are `amount`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The auction item UID.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`, `highBid`, `highBid.customer`, `maxBid`.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"startsAt":{"type":"string","format":"date-time","description":"The date and time the auction opens (ISO 8601). Must be sent together with endsAt. Ignored for items in an auction event."},"endsAt":{"type":"string","format":"date-time","description":"The date and time the auction closes (ISO 8601). Must be sent together with startsAt. Ignored for items in an auction event."},"startPrice":{"type":"number","description":"The starting price in major currency units (e.g. 10.50). Cannot be changed once a bid has been placed.","minimum":0.01},"reservePrice":{"type":["number","null"],"description":"The reserve price in major currency units. Must be greater than or equal to the start price.","minimum":0.01},"offerRuleId":{"type":["string","null"],"description":"The UID of an active auction offer rule to attach."},"productFeeId":{"type":["string","null"],"description":"The UID of an active auction product fee to attach."},"bidIncrementStrategy":{"type":"object","description":"How bids are incremented. Omit to use the default tiered increment table.","properties":{"strategy":{"type":"string","description":"The increment type.","enum":["fixed_amount","percentage","tier"]},"value":{"type":"object","properties":{"amount":{"type":"number","description":"The fixed increment in major currency units. Required when strategy is `fixed_amount`.","minimum":0.1},"percentage":{"type":"number","description":"The increment as a percentage of the current price. Required when strategy is `percentage`.","minimum":0.1,"maximum":100}}}}},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether customers may set a maximum (proxy) bid. Defaults to true."}}},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the auction is extended when a bid is placed near the end. Defaults to false."},"extendFrom":{"type":["integer","null"],"description":"Seconds before the end within which a bid triggers an extension.","minimum":1,"maximum":65535},"extendDuration":{"type":["integer","null"],"description":"Seconds the auction is extended by. Must be greater than or equal to extendFrom.","minimum":1,"maximum":65535}}}}}}}},"responses":{"200":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}},"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"maxBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["max-bids"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/VariantResource"},{"$ref":"#/components/schemas/ProductResource"},{"$ref":"#/components/schemas/BidResource"},{"$ref":"#/components/schemas/CustomerResource"},{"$ref":"#/components/schemas/MaxBidResource"}]}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"description":"Unprocessable entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}}}}}
```
# End an auction listing
Ends an active or scheduled listing early.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.\n\nPrice attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.\n\nThe **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"reservePrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"},"extendFrom":{"type":["integer","null"]},"extendDuration":{"type":["integer","null"]}},"required":["enabled","extendFrom","extendDuration"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string"},"reserveMet":{"type":"string"},"canceledAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"},"BidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"placedAt":{"type":["string","null"],"format":"date-time"},"automatic":{"type":["boolean","null"]}}}},"required":["id","type"],"title":"BidResource"},"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items/{id}/end":{"patch":{"operationId":"endAuctionItem","description":"Ends an active or scheduled listing early.","summary":"End an auction listing","tags":["Auction Items"],"parameters":[{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `reservePrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `reserveMet`, `canceledAt`, `archivedAt`, `processed`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`, `automatic`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The auction item UID.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `highBid`, `highBid.customer`.","schema":{"type":"string"}}],"responses":{"200":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BidResource"},{"$ref":"#/components/schemas/CustomerResource"}]}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"description":"This auction item has already ended.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}}}}}
```
# Cancel an auction listing
Cancels a listing without assigning a winner.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.\n\nPrice attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.\n\nThe **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"reservePrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"},"extendFrom":{"type":["integer","null"]},"extendDuration":{"type":["integer","null"]}},"required":["enabled","extendFrom","extendDuration"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string"},"reserveMet":{"type":"string"},"canceledAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"},"BidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"placedAt":{"type":["string","null"],"format":"date-time"},"automatic":{"type":["boolean","null"]}}}},"required":["id","type"],"title":"BidResource"},"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items/{id}/cancel":{"patch":{"operationId":"cancelAuctionItem","description":"Cancels a listing without assigning a winner.","summary":"Cancel an auction listing","tags":["Auction Items"],"parameters":[{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `reservePrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `reserveMet`, `canceledAt`, `archivedAt`, `processed`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`, `automatic`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The auction item UID.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `highBid`, `highBid.customer`.","schema":{"type":"string"}}],"responses":{"200":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BidResource"},{"$ref":"#/components/schemas/CustomerResource"}]}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"description":"Unprocessable entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}}}}}
```
# Place a bid
Places a bid on an active auction item.
You must provide either **max\_amount** for a maximum bid (automatic bidding), **amount** for a straight bid, or both.
* **Straight bid** (`amount`): Places a single bid at the specified amount.
* **Proxy bid** (`max_amount`): Sets the maximum amount the system will automatically bid up to on behalf of the customer. The system places the minimum winning bid and automatically increments as competing bids are received, up to the maximum.
* **Both** (`amount` + `max_amount`): Places a straight bid at the specified amount and sets a proxy maximum for automatic bidding.
The response returns the updated **auction item** with a `meta.status` field indicating whether the customer is the `high_bidder` or was automatically `outbid` by proxy bidding.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.\n\nPrice attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.\n\nThe **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"reservePrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"},"extendFrom":{"type":["integer","null"]},"extendDuration":{"type":["integer","null"]}},"required":["enabled","extendFrom","extendDuration"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string"},"reserveMet":{"type":"string"},"canceledAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"},"BidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"placedAt":{"type":["string","null"],"format":"date-time"},"automatic":{"type":["boolean","null"]}}}},"required":["id","type"],"title":"BidResource"},"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items/{id}/place-bid":{"post":{"operationId":"placeBid","description":"Places a bid on an active auction item.\n\nYou must provide either **max_amount** for a maximum bid (automatic bidding), **amount** for a straight bid, or both.\n\n- **Straight bid** (`amount`): Places a single bid at the specified amount.\n- **Proxy bid** (`max_amount`): Sets the maximum amount the system will automatically bid up to on behalf of the customer. The system places the minimum winning bid and automatically increments as competing bids are received, up to the maximum.\n- **Both** (`amount` + `max_amount`): Places a straight bid at the specified amount and sets a proxy maximum for automatic bidding.\n\nThe response returns the updated **auction item** with a `meta.status` field indicating whether the customer is the `high_bidder` or was automatically `outbid` by proxy bidding.","summary":"Place a bid","tags":["Auction Items"],"parameters":[{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `reservePrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `reserveMet`, `canceledAt`, `archivedAt`, `processed`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`, `automatic`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The auction item UID.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `highBid`, `highBid.customer`.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string","description":"The customer UID."},"amount":{"type":["number","null"],"description":"The bid amount in major currency units (e.g. 10.50).","minimum":0},"maxAmount":{"type":["number","null"],"description":"The maximum (proxy) bid in major currency units (e.g. 10.50).","minimum":0}},"required":["customerId"]}}}},"responses":{"200":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BidResource"},{"$ref":"#/components/schemas/CustomerResource"}]}},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["outbid","high_bidder"]}},"required":["status"]}},"required":["data","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"403":{"description":"The provided user does not have access to this resource.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"422":{"description":"The bid could not be placed. Inspect `errors[0].code` for the specific reason:\n\n- `user_not_found` — customer was not found for the given `customerId`.\n- `auction_ended` — the auction has already ended.\n- `amount_below_start_price` — the straight bid `amount` is below the auction's start price.\n- `amount_below_showing_bid` — the straight bid `amount` is at or below the current high bid plus the required increment. `meta.minimum_bid` shows the minimum acceptable value.\n- `max_amount_below_start_price` — the max bid `maxAmount` is below the auction's start price. `meta.minimum_bid` shows the start price.\n- `max_amount_below_showing_bid` — the max bid `maxAmount` is at or below the current high bid plus the required increment. `meta.minimum_bid` shows the minimum acceptable value.\n- `max_amount_below_current_bid` — the customer is already the high bidder and the new `maxAmount` is lower than their existing showing bid. `meta.minimum_bid` shows the existing bid amount.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}}}}}
```
# Customers
Resolve a customer by their Shopify customer ID by filtering the list on `externalId`.
# List customers
Returns a paginated list of customers.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Customers","description":"Resolve a customer by their Shopify customer ID by filtering the list on `externalId`."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/customers":{"get":{"operationId":"listCustomers","description":"Returns a paginated list of customers.","summary":"List customers","tags":["Customers"],"parameters":[{"name":"filter[externalId]","in":"query","description":"Filter by the Shopify customer ID","schema":{"type":"string"}},{"name":"perPage","in":"query","description":"Results per page (1–100).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort by field. Prefix with `-` for descending order. Available values: `createdAt`, `-createdAt`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated set of `CustomerResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerResource"}},"meta":{"type":"object","properties":{"currentPage":{"type":"integer","minimum":1},"from":{"type":["integer","null"],"minimum":1},"lastPage":{"type":"integer","minimum":1},"perPage":{"type":"integer","description":"Number of items shown per page.","minimum":0},"to":{"type":["integer","null"],"description":"Number of the last item in the slice.","minimum":1},"total":{"type":"integer","description":"Total number of items being paginated.","minimum":0}},"required":["currentPage","from","lastPage","perPage","to","total"]}},"required":["data","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
# Retrieve a customer
Retrieve the details for a single customer by their customer ID.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Customers","description":"Resolve a customer by their Shopify customer ID by filtering the list on `externalId`."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"externalId":{"type":["integer","null"]},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/customers/{id}":{"get":{"operationId":"getCustomer","description":"Retrieve the details for a single customer by their customer ID.","summary":"Retrieve a customer","tags":["Customers"],"parameters":[{"name":"fields[customers]","in":"query","description":"Available values are `name`, `firstName`, `lastName`, `externalId`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The customer ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"`CustomerResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CustomerResource"}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
# Auction Items
An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`.
Price attributes such as **startPrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.
The **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.
The **automaticBidding** and **softClose** objects expose a single `enabled` boolean indicating whether each feature is active for the item.
The **reserveMet** boolean indicates whether the current high bid meets the auction's reserve, without exposing the reserve price itself. The **processed** attribute indicates whether the listing has been finalized, including assigning a winner — listings are typically processed within a minute after the end time.
Per-viewer fields (whether the authenticated customer has bid, is the high bidder, or is watching the item) are opt-in. Request fields by name with the `viewerFields` query parameter (e.g. `viewerFields=hasBid,isWatching`).
## List Auction Items
> Returns a paginated list of auction items that are scheduled, active, or completed. Canceled and archived items are excluded.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`.\n\nPrice attributes such as **startPrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **automaticBidding** and **softClose** objects expose a single `enabled` boolean indicating whether each feature is active for the item.\n\nThe **reserveMet** boolean indicates whether the current high bid meets the auction's reserve, without exposing the reserve price itself. The **processed** attribute indicates whether the listing has been finalized, including assigning a winner — listings are typically processed within a minute after the end time.\n\nPer-viewer fields (whether the authenticated customer has bid, is the high bidder, or is watching the item) are opt-in. Request fields by name with the `viewerFields` query parameter (e.g. `viewerFields=hasBid,isWatching`)."}],"servers":[{"url":"https://api.auctionplusapp.com/storefront/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string","enum":["scheduled","active","completed"]},"enableReserve":{"type":"boolean"},"reserveMet":{"type":"boolean"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"canceledAt":{"type":["string","null"],"format":"date-time"}}},"meta":{"type":"object","properties":{"viewer":{"type":"object","properties":{"hasBid":{"type":"boolean"},"isWatching":{"type":"boolean"},"isHighBidder":{"type":"boolean"}},"required":["hasBid","isWatching","isHighBidder"]}}}},"required":["id","type","meta"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"}},"responses":{"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items":{"get":{"operationId":"listAuctionItems","description":"Returns a paginated list of auction items that are scheduled, active, or completed. Canceled and archived items are excluded.","summary":"List Auction Items","tags":["Auction Items"],"parameters":[{"name":"filter[status]","in":"query","schema":{"type":"string","enum":["active","scheduled","completed"]}},{"name":"filter[viewerHasBid]","in":"query","description":"Limit results to auction items the authenticated customer has bid on.","schema":{"type":"string","enum":["true","false","1","0"]}},{"name":"filter[eventId]","in":"query","schema":{"type":"string"}},{"name":"viewerFields","in":"query","schema":{"type":["string","null"]}},{"name":"perPage","in":"query","description":"Results per page (1–100).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `enableReserve`, `reserveMet`, `processed`, `createdAt`, `updatedAt`, `canceledAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[max-bids]","in":"query","description":"Available values are `amount`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-winners]","in":"query","description":"Available values are `amount`, `notifiedAt`, `paymentDueAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`, `highBid`, `highBid.customer`, `viewerMaxBid`, `viewerWin`.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort by field. Prefix with `-` for descending order. Available values: `startsAt`, `-startsAt`, `endsAt`, `-endsAt`, `totalBids`, `-totalBids`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated set of `AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}},"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"viewerMaxBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["max-bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"viewerWin":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["auction-winners"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]}},"meta":{"type":"object","properties":{"currentPage":{"type":"integer","minimum":1},"from":{"type":["integer","null"],"minimum":1},"lastPage":{"type":"integer","minimum":1},"perPage":{"type":"integer","description":"Number of items shown per page.","minimum":0},"to":{"type":["integer","null"],"description":"Number of the last item in the slice.","minimum":1},"total":{"type":"integer","description":"Total number of items being paginated.","minimum":0}},"required":["currentPage","from","lastPage","perPage","to","total"]}},"required":["data","meta"]}}}},"401":{"description":"The provided user does not have access to this resource.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
## Search Auction Items
> Returns a paginated list of auction items that match the search query.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`.\n\nPrice attributes such as **startPrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **automaticBidding** and **softClose** objects expose a single `enabled` boolean indicating whether each feature is active for the item.\n\nThe **reserveMet** boolean indicates whether the current high bid meets the auction's reserve, without exposing the reserve price itself. The **processed** attribute indicates whether the listing has been finalized, including assigning a winner — listings are typically processed within a minute after the end time.\n\nPer-viewer fields (whether the authenticated customer has bid, is the high bidder, or is watching the item) are opt-in. Request fields by name with the `viewerFields` query parameter (e.g. `viewerFields=hasBid,isWatching`)."}],"servers":[{"url":"https://api.auctionplusapp.com/storefront/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string","enum":["scheduled","active","completed"]},"enableReserve":{"type":"boolean"},"reserveMet":{"type":"boolean"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"canceledAt":{"type":["string","null"],"format":"date-time"}}},"meta":{"type":"object","properties":{"viewer":{"type":"object","properties":{"hasBid":{"type":"boolean"},"isWatching":{"type":"boolean"},"isHighBidder":{"type":"boolean"}},"required":["hasBid","isWatching","isHighBidder"]}}}},"required":["id","type","meta"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items/search":{"get":{"operationId":"searchAuctionItems","description":"Returns a paginated list of auction items that match the search query.","summary":"Search Auction Items","tags":["Auction Items"],"parameters":[{"name":"filter[status]","in":"query","schema":{"type":"string","enum":["active","scheduled","completed"]}},{"name":"filter[viewerHasBid]","in":"query","description":"Limit results to auction items the authenticated customer has bid on.","schema":{"type":"string","enum":["true","false","1","0"]}},{"name":"filter[eventId]","in":"query","schema":{"type":"string"}},{"name":"viewerFields","in":"query","schema":{"type":["string","null"]}},{"name":"perPage","in":"query","description":"Results per page (1–100).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"query","in":"query","required":true,"description":"The text to match against auction item titles.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `enableReserve`, `reserveMet`, `processed`, `createdAt`, `updatedAt`, `canceledAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[max-bids]","in":"query","description":"Available values are `amount`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-winners]","in":"query","description":"Available values are `amount`, `notifiedAt`, `paymentDueAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`, `highBid`, `highBid.customer`, `viewerMaxBid`, `viewerWin`.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort by field. Prefix with `-` for descending order. Available values: `startsAt`, `-startsAt`, `endsAt`, `-endsAt`, `totalBids`, `-totalBids`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated set of `AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}},"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"viewerMaxBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["max-bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"viewerWin":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["auction-winners"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]}},"meta":{"type":"object","properties":{"currentPage":{"type":"integer","minimum":1},"from":{"type":["integer","null"],"minimum":1},"lastPage":{"type":"integer","minimum":1},"perPage":{"type":"integer","description":"Number of items shown per page.","minimum":0},"to":{"type":["integer","null"],"description":"Number of the last item in the slice.","minimum":1},"total":{"type":"integer","description":"Total number of items being paginated.","minimum":0}},"required":["currentPage","from","lastPage","perPage","to","total"]}},"required":["data","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
## Retrieve an Auction Item
> Retrieves the details for a single auction item.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`.\n\nPrice attributes such as **startPrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **automaticBidding** and **softClose** objects expose a single `enabled` boolean indicating whether each feature is active for the item.\n\nThe **reserveMet** boolean indicates whether the current high bid meets the auction's reserve, without exposing the reserve price itself. The **processed** attribute indicates whether the listing has been finalized, including assigning a winner — listings are typically processed within a minute after the end time.\n\nPer-viewer fields (whether the authenticated customer has bid, is the high bidder, or is watching the item) are opt-in. Request fields by name with the `viewerFields` query parameter (e.g. `viewerFields=hasBid,isWatching`)."}],"servers":[{"url":"https://api.auctionplusapp.com/storefront/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string","enum":["scheduled","active","completed"]},"enableReserve":{"type":"boolean"},"reserveMet":{"type":"boolean"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"canceledAt":{"type":["string","null"],"format":"date-time"}}},"meta":{"type":"object","properties":{"viewer":{"type":"object","properties":{"hasBid":{"type":"boolean"},"isWatching":{"type":"boolean"},"isHighBidder":{"type":"boolean"}},"required":["hasBid","isWatching","isHighBidder"]}}}},"required":["id","type","meta"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items/{id}":{"get":{"operationId":"getAuctionItem","description":"Retrieves the details for a single auction item.","summary":"Retrieve an Auction Item","tags":["Auction Items"],"parameters":[{"name":"viewerFields","in":"query","schema":{"type":["string","null"]}},{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `enableReserve`, `reserveMet`, `processed`, `createdAt`, `updatedAt`, `canceledAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[max-bids]","in":"query","description":"Available values are `amount`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-winners]","in":"query","description":"Available values are `amount`, `notifiedAt`, `paymentDueAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The auction item UID.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`, `highBid`, `highBid.customer`, `viewerMaxBid`, `viewerWin`.","schema":{"type":"string"}}],"responses":{"200":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}},"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"viewerMaxBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["max-bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"viewerWin":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["auction-winners"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
## Place a Bid
> Places a bid on an active auction item on behalf of the authenticated storefront customer.\
> \
> You must provide either \*\*maxAmount\*\* for a maximum bid (automatic bidding), \*\*amount\*\* for a straight bid, or both.\
> \
> \- \*\*Straight bid\*\* (\`amount\`): Places a single bid at the specified amount.\
> \- \*\*Proxy bid\*\* (\`maxAmount\`): Sets the maximum amount the system will automatically bid up to on behalf of the customer. The system places the minimum winning bid and automatically increments as competing bids are received, up to the maximum.\
> \- \*\*Both\*\* (\`amount\` + \`maxAmount\`): Places a straight bid at the specified amount and sets a proxy maximum for automatic bidding.\
> \
> The response returns the updated \*\*auction item\*\* with a \`meta.status\` field indicating whether the customer is the \`high\_bidder\` or was automatically \`outbid\` by proxy bidding.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`.\n\nPrice attributes such as **startPrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **automaticBidding** and **softClose** objects expose a single `enabled` boolean indicating whether each feature is active for the item.\n\nThe **reserveMet** boolean indicates whether the current high bid meets the auction's reserve, without exposing the reserve price itself. The **processed** attribute indicates whether the listing has been finalized, including assigning a winner — listings are typically processed within a minute after the end time.\n\nPer-viewer fields (whether the authenticated customer has bid, is the high bidder, or is watching the item) are opt-in. Request fields by name with the `viewerFields` query parameter (e.g. `viewerFields=hasBid,isWatching`)."}],"servers":[{"url":"https://api.auctionplusapp.com/storefront/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"PlaceBidRequest":{"type":"object","properties":{"viewerFields":{"type":["string","null"]},"amount":{"type":["number","null"],"description":"The bid amount in major currency units (e.g. 10.50).","minimum":0},"maxAmount":{"type":["number","null"],"description":"The maximum (proxy) bid in major currency units (e.g. 10.50).","minimum":0}},"title":"PlaceBidRequest"},"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"position":{"type":["integer","null"],"description":"Position within the auction event, or null if the item is not part of an event."},"status":{"type":"string","enum":["scheduled","active","completed"]},"enableReserve":{"type":"boolean"},"reserveMet":{"type":"boolean"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"canceledAt":{"type":["string","null"],"format":"date-time"}}},"meta":{"type":"object","properties":{"viewer":{"type":"object","properties":{"hasBid":{"type":"boolean"},"isWatching":{"type":"boolean"},"isHighBidder":{"type":"boolean"}},"required":["hasBid","isWatching","isHighBidder"]}}}},"required":["id","type","meta"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"}}},"paths":{"/auction-items/{id}/place-bid":{"post":{"operationId":"placeBid","description":"Places a bid on an active auction item on behalf of the authenticated storefront customer.\n\nYou must provide either **maxAmount** for a maximum bid (automatic bidding), **amount** for a straight bid, or both.\n\n- **Straight bid** (`amount`): Places a single bid at the specified amount.\n- **Proxy bid** (`maxAmount`): Sets the maximum amount the system will automatically bid up to on behalf of the customer. The system places the minimum winning bid and automatically increments as competing bids are received, up to the maximum.\n- **Both** (`amount` + `maxAmount`): Places a straight bid at the specified amount and sets a proxy maximum for automatic bidding.\n\nThe response returns the updated **auction item** with a `meta.status` field indicating whether the customer is the `high_bidder` or was automatically `outbid` by proxy bidding.","summary":"Place a Bid","tags":["Auction Items"],"parameters":[{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `enableReserve`, `reserveMet`, `processed`, `createdAt`, `updatedAt`, `canceledAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[max-bids]","in":"query","description":"Available values are `amount`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-winners]","in":"query","description":"Available values are `amount`, `notifiedAt`, `paymentDueAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The auction item UID.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `highBid`, `highBid.customer`, `viewerMaxBid`, `viewerWin`.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaceBidRequest"}}}},"responses":{"200":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"viewerMaxBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["max-bids"]},"id":{"type":"string"}},"required":["type","id"]}}},"viewerWin":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["auction-winners"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["outbid","high_bidder"]}},"required":["status"]}},"required":["data","meta"]}}}},"401":{"description":"The provided user does not have access to this resource.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"403":{"description":"The provided user does not have access to this resource.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"422":{"description":"The bid could not be placed. Inspect `errors[0].code` for the specific reason:\n\n- `access_denied` — the customer is not permitted to bid (e.g. not approved for bidder registration).\n- `auction_ended` — the auction has already ended.\n- `amount_below_start_price` — the straight bid `amount` is below the auction's start price.\n- `amount_below_showing_bid` — the straight bid `amount` is at or below the current high bid plus the required increment. `meta.minimum_bid` shows the minimum acceptable value.\n- `max_amount_below_start_price` — the max bid `maxAmount` is below the auction's start price. `meta.minimum_bid` shows the start price.\n- `max_amount_below_showing_bid` — the max bid `maxAmount` is at or below the current high bid plus the required increment. `meta.minimum_bid` shows the minimum acceptable value.\n- `max_amount_below_current_bid` — the customer is already the high bidder and the new `maxAmount` is lower than their existing showing bid. `meta.minimum_bid` shows the existing bid amount.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}}}}}
```
# Variants
## List Variants
> Returns the active variants matching the required \`filter\[externalId]\` filter.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Variants"}],"servers":[{"url":"https://api.auctionplusapp.com/storefront/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"VariantResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"variants"},"attributes":{"type":"object","properties":{"externalId":{"type":["integer","null"]},"displayName":{"type":"string"},"title":{"type":["string","null"]},"price":{"$ref":"#/components/schemas/Money"},"photoUrl":{"type":["string","null"]}}}},"required":["id","type"],"title":"VariantResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/variants":{"get":{"operationId":"listVariants","description":"Returns the active variants matching the required `filter[externalId]` filter.","summary":"List Variants","tags":["Variants"],"parameters":[{"name":"filter[externalId]","in":"query","required":true,"description":"A comma-separated list of Shopify external variant IDs to fetch (maximum 50).","schema":{"type":"string"}},{"name":"viewerFields","in":"query","schema":{"type":["string","null"]}},{"name":"perPage","in":"query","description":"Results per page (1–100).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `enableReserve`, `reserveMet`, `processed`, `createdAt`, `updatedAt`, `canceledAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `product`, `currentAuctionItem`, `currentAuctionItem.highBid`, `currentAuctionItem.highBid.customer`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated set of `VariantResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/VariantResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"currentAuctionItem":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["auction-items"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]}},"meta":{"type":"object","properties":{"currentPage":{"type":"integer","minimum":1},"from":{"type":["integer","null"],"minimum":1},"lastPage":{"type":"integer","minimum":1},"perPage":{"type":"integer","description":"Number of items shown per page.","minimum":0},"to":{"type":["integer","null"],"description":"Number of the last item in the slice.","minimum":1},"total":{"type":"integer","description":"Total number of items being paginated.","minimum":0}},"required":["currentPage","from","lastPage","perPage","to","total"]}},"required":["data","meta"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
# Watched Items
A watched item is a product variant the authenticated customer is following.
## List Watched Items
> Returns every variant the authenticated customer is watching, most recently updated first.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Watched Items","description":"A watched item is a product variant the authenticated customer is following."}],"servers":[{"url":"https://api.auctionplusapp.com/storefront/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"WatchedItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"watched-items"},"attributes":{"type":"object","properties":{"automatic":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"WatchedItemResource"}},"responses":{"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/watched-items":{"get":{"operationId":"listWatchedItems","description":"Returns every variant the authenticated customer is watching, most recently updated first.","summary":"List Watched Items","tags":["Watched Items"],"parameters":[{"name":"filter[listingType]","in":"query","schema":{"type":"string","enum":["auction","product"]}},{"name":"viewerFields","in":"query","schema":{"type":["string","null"]}},{"name":"perPage","in":"query","description":"Results per page (1–100).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"fields[watched-items]","in":"query","description":"Available values are `automatic`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `enableReserve`, `reserveMet`, `processed`, `createdAt`, `updatedAt`, `canceledAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[max-bids]","in":"query","description":"Available values are `amount`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-winners]","in":"query","description":"Available values are `amount`, `notifiedAt`, `paymentDueAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`, `variant.currentAuctionItem`, `variant.currentAuctionItem.highBid`, `variant.currentAuctionItem.highBid.customer`, `variant.currentAuctionItem.viewerMaxBid`, `variant.currentAuctionItem.viewerWin`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated set of `WatchedItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/WatchedItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]}},"meta":{"type":"object","properties":{"currentPage":{"type":"integer","minimum":1},"from":{"type":["integer","null"],"minimum":1},"lastPage":{"type":"integer","minimum":1},"perPage":{"type":"integer","description":"Number of items shown per page.","minimum":0},"to":{"type":["integer","null"],"description":"Number of the last item in the slice.","minimum":1},"total":{"type":"integer","description":"Total number of items being paginated.","minimum":0}},"required":["currentPage","from","lastPage","perPage","to","total"]}},"required":["data","meta"]}}}},"401":{"description":"The provided user does not have access to this resource.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
## Watch a Variant
> Adds a variant to the authenticated customer's watched items.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Watched Items","description":"A watched item is a product variant the authenticated customer is following."}],"servers":[{"url":"https://api.auctionplusapp.com/storefront/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"schemas":{"StoreWatchedItemRequest":{"type":"object","properties":{"viewerFields":{"type":["string","null"]},"externalVariantId":{"type":"integer","description":"The Shopify external variant ID to watch."}},"required":["externalVariantId"],"title":"StoreWatchedItemRequest"},"WatchedItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"watched-items"},"attributes":{"type":"object","properties":{"automatic":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"WatchedItemResource"}},"responses":{"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/watched-items":{"post":{"operationId":"watchItem","description":"Adds a variant to the authenticated customer's watched items.","summary":"Watch a Variant","tags":["Watched Items"],"parameters":[{"name":"fields[watched-items]","in":"query","description":"Available values are `automatic`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[variants]","in":"query","description":"Available values are `externalId`, `displayName`, `title`, `price`, `photoUrl`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `position`, `status`, `enableReserve`, `reserveMet`, `processed`, `createdAt`, `updatedAt`, `canceledAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[products]","in":"query","description":"Available values are `externalId`, `title`, `vendor`, `type`, `photoUrl`, `handle`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `variant`, `product`, `variant.currentAuctionItem`.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreWatchedItemRequest"}}}},"responses":{"201":{"description":"`WatchedItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/WatchedItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"variant":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["variants"]},"id":{"type":"string"}},"required":["type","id"]}}},"product":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["products"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]}},"required":["data"]}}}},"401":{"description":"The provided user does not have access to this resource.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```
## Unwatch a Variant
> Removes a variant from the authenticated customer's watched item lists.
```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Watched Items","description":"A watched item is a product variant the authenticated customer is following."}],"servers":[{"url":"https://api.auctionplusapp.com/storefront/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking Generate API token.","scheme":"bearer"}},"responses":{"ValidationException":{"description":"Validation error","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/watched-items":{"delete":{"operationId":"unwatchItem","description":"Removes a variant from the authenticated customer's watched item lists.","summary":"Unwatch a Variant","tags":["Watched Items"],"parameters":[{"name":"viewerFields","in":"query","schema":{"type":["string","null"]}},{"name":"externalVariantId","in":"query","required":true,"description":"The Shopify external variant ID to unwatch.","schema":{"type":"integer"}}],"responses":{"204":{"description":"No content"},"401":{"description":"The provided user does not have access to this resource.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```