> For the complete documentation index, see [llms.txt](https://docs.auctionplusapp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.auctionplusapp.com/storefront-api/auction-items.md).
# 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 Storefront 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":[]},{"apiKey":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"Your storefront (public) token, sent as Authorization: Bearer STOREFRONT_TOKEN. Generate one in Auction Plus under Settings > API, in the Storefront API section, by clicking Generate Public Token. Required on every request.","scheme":"bearer"},"apiKey":{"type":"apiKey","description":"A Shopify Customer Account API access token for the signed-in customer. Optional: send it to identify the customer for the request. Required for endpoints that act on behalf of a customer (placing bids, watching items) and the viewerFields parameter.","in":"header","name":"X-Shopify-Customer-Access-Token"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"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":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"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","description":"Comma-separated per-viewer fields to return under `meta.viewer` on the resource and any included resources. Available values: `hasBid`, `isWatching`, `isHighBidder`, `isOwner`. Requires an authenticated customer.","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 Storefront 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":[]},{"apiKey":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"Your storefront (public) token, sent as Authorization: Bearer STOREFRONT_TOKEN. Generate one in Auction Plus under Settings > API, in the Storefront API section, by clicking Generate Public Token. Required on every request.","scheme":"bearer"},"apiKey":{"type":"apiKey","description":"A Shopify Customer Account API access token for the signed-in customer. Optional: send it to identify the customer for the request. Required for endpoints that act on behalf of a customer (placing bids, watching items) and the viewerFields parameter.","in":"header","name":"X-Shopify-Customer-Access-Token"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"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":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"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","description":"Comma-separated per-viewer fields to return under `meta.viewer` on the resource and any included resources. Available values: `hasBid`, `isWatching`, `isHighBidder`, `isOwner`. Requires an authenticated customer.","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 Storefront 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":[]},{"apiKey":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"Your storefront (public) token, sent as Authorization: Bearer STOREFRONT_TOKEN. Generate one in Auction Plus under Settings > API, in the Storefront API section, by clicking Generate Public Token. Required on every request.","scheme":"bearer"},"apiKey":{"type":"apiKey","description":"A Shopify Customer Account API access token for the signed-in customer. Optional: send it to identify the customer for the request. Required for endpoints that act on behalf of a customer (placing bids, watching items) and the viewerFields parameter.","in":"header","name":"X-Shopify-Customer-Access-Token"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"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":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"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","description":"Comma-separated per-viewer fields to return under `meta.viewer` on the resource and any included resources. Available values: `hasBid`, `isWatching`, `isHighBidder`, `isOwner`. Requires an authenticated customer.","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 Storefront 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":[]},{"apiKey":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"Your storefront (public) token, sent as Authorization: Bearer STOREFRONT_TOKEN. Generate one in Auction Plus under Settings > API, in the Storefront API section, by clicking Generate Public Token. Required on every request.","scheme":"bearer"},"apiKey":{"type":"apiKey","description":"A Shopify Customer Account API access token for the signed-in customer. Optional: send it to identify the customer for the request. Required for endpoints that act on behalf of a customer (placing bids, watching items) and the viewerFields parameter.","in":"header","name":"X-Shopify-Customer-Access-Token"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"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":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"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":"viewerFields","in":"query","description":"Comma-separated per-viewer fields to return under `meta.viewer` on the resource and any included resources. Available values: `hasBid`, `isWatching`, `isHighBidder`, `isOwner`. Requires an authenticated customer.","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":{"type":"object","properties":{"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}}}}}},"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"]}}}}}}}}}
```