List watched items

Returns every variant the authenticated customer is watching, most recently updated first.

get

Authorizations

AuthorizationstringRequired

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.

Query parameters

filter[listingType]string · enumOptionalPossible values:

viewerFieldsstring · nullableOptional

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.

perPageinteger · min: 1 · max: 100Optional

Results per page (1–100).

fields[watched-items]stringOptional

Available values are automatic, createdAt, updatedAt. You can include multiple values by separating them with a comma.

fields[variants]stringOptional

Available values are externalId, displayName, title, price, photoUrl. You can include multiple values by separating them with a comma.

fields[auction-items]stringOptional

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.

fields[products]stringOptional

Available values are externalId, title, vendor, type, photoUrl, handle. You can include multiple values by separating them with a comma.

fields[bids]stringOptional

Available values are amount, placedAt. You can include multiple values by separating them with a comma.

fields[max-bids]stringOptional

Available values are amount, createdAt. You can include multiple values by separating them with a comma.

fields[auction-winners]stringOptional

Available values are amount, notifiedAt, paymentDueAt. You can include multiple values by separating them with a comma.

includestringOptional

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.

Responses

200

Paginated set of WatchedItemResource

application/vnd.api+json

401

The provided user does not have access to this resource.

application/vnd.api+json

422

Validation error

application/vnd.api+json

get/watched-items

GET /storefront/v1/watched-items HTTP/1.1
Host: api.auctionplusapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "type": "text",
      "attributes": {
        "automatic": true,
        "createdAt": null,
        "updatedAt": null
      },
      "relationships": {
        "variant": {
          "data": {
            "type": "variants",
            "id": "text"
          }
        },
        "product": {
          "data": {
            "type": "products",
            "id": "text"
          }
        }
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "from": null,
    "lastPage": 1,
    "perPage": 1,
    "to": null,
    "total": 1
  }
}