Watchlist

List user's watchlist product-listings

Changed on

Retrieves all product-listings in the authenticated user's watchlist in watchlist creation order. Each result contains current product data and complete user-specific state. Accepts Cognito JWT authentication or an Aura Historia access token with watchlist:read.

get/api/v1/me/watchlist

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/me/watchlist
  • Auth: HTTP bearer

Query parameters

language'de' | 'en' | 'fr' | 'es' | 'it' | 'zh' | 'pt' | 'pl' | 'tr' | 'nl' | 'cs' | 'ja' | 'ru' | 'ar'

Supported language codes (ISO 639-1 canonical values):

  • de: German (includes de-DE, de-AT, de-CH, de-LU, de-LI)
  • en: English (includes en-US, en-GB, en-AU, en-CA, en-NZ, and backend-specific accepted alias en_IE)
  • fr: French (includes fr-FR, fr-CA, fr-BE, fr-CH, fr-LU)
  • es: Spanish (includes es-ES, es-MX, es-AR, es-CO, es-CL, es-PE, es-VE)
  • it: Italian (includes it-IT, it-CH)
  • zh: Chinese (Simplified) (includes zh-CN, zh-Hans)
  • pt: Portuguese (includes pt-PT, pt-BR)
  • pl: Polish (includes pl-PL)
  • tr: Turkish (includes tr-TR)
  • nl: Dutch (includes nl-NL, nl-BE)
  • cs: Czech (includes cs-CZ)
  • ja: Japanese (includes ja-JP)
  • ru: Russian (includes ru-RU)
  • ar: Arabic (includes ar-SA, ar-EG, ar-AE)

de, en, fr, es, and it are fully supported localization/translation-target languages. zh, pt, pl, tr, nl, cs, ja, ru, and ar are ingestion-only languages: they can appear in stored/native content and are accepted anywhere LanguageData is used, but backend-generated translations and fallback localized strings are not produced in these languages.

Example:de

Preferred language for localized content. Defaults to en when omitted.

currency'EUR' | 'GBP' | 'USD' | 'AUD' | 'CAD' | 'NZD' | 'CNY' | 'BRL' | 'PLN' | 'TRY' | 'JPY' | 'CZK' | 'RUB' | 'AED' | 'SAR' | 'HKD' | 'SGD' | 'CHF' | 'ZAR' | 'SEK' | 'DKK' | 'NOK' | 'KRW' | 'INR' | 'TWD' | 'HUF' | 'RON' | 'MXN' | 'THB'

Supported currencies (ISO 4217 codes):

  • EUR: Euro
  • GBP: British Pound
  • USD: US Dollar
  • AUD: Australian Dollar
  • CAD: Canadian Dollar
  • NZD: New Zealand Dollar
  • CNY: Chinese Yuan
  • BRL: Brazilian Real
  • PLN: Polish Złoty
  • TRY: Turkish Lira
  • JPY: Japanese Yen
  • CZK: Czech Koruna
  • RUB: Russian Ruble
  • AED: UAE Dirham
  • SAR: Saudi Riyal
  • HKD: Hong Kong Dollar
  • SGD: Singapore Dollar
  • CHF: Swiss Franc
  • ZAR: South African Rand
  • SEK: Swedish Krona
  • DKK: Danish Krone
  • NOK: Norwegian Krone
  • KRW: South Korean Won
  • INR: Indian Rupee
  • TWD: New Taiwan Dollar
  • HUF: Hungarian Forint
  • RON: Romanian Leu
  • MXN: Mexican Peso
  • THB: Thai Baht
Example:EUR

Display currency. Defaults to EUR.

sizeinteger

ProductListings per page. Defaults to 21; values are clamped to 1..100.

searchAfterstring

JSON array cursor returned by the preceding page: [RFC3339 timestamp, ProductListing ID].

Response

Watchlist product-listings retrieved successfully

sizeinteger required

Number of items returned in the current page.

searchAfterstring[] nullable

Example response

{
  "items": [
    {
      "item": {
        "productListingTitleSlugId": "museum-cabinet-18-19-century-a1b2c3",
        "productTitle": {
          "language": "de"
        },
        "productDescription": {
          "language": "de"
        },
        "title": {
          "language": "de"
        },
        "description": {
          "language": "de"
        },
        "pricing": {
          "source": {
            "price": {
              "currency": "EUR"
            },
            "priceEstimateMin": {
              "currency": "EUR",
              "amount": 2999
            },
            "priceEstimateMax": {
              "currency": "EUR",
              "amount": 2999
            }
          },
          "display": {
            "price": {
              "currency": "EUR"
            },
            "priceEstimateMin": {
              "currency": "EUR",
              "amount": 2999
            },
            "priceEstimateMax": {
              "currency": "EUR",
              "amount": 2999
            }
          }
        },
        "availability": "IN_STOCK",
        "lifecycle": "ACTIVE",
        "images": [
          {
            "url": "https://my-listing-source.com/images/product-1.jpg"
          }
        ],
        "auction": {
          "name": {
            "language": "de"
          }
        }
      },
      "userState": {
        "watchlist": {
          "watching": true
        },
        "searchFilter": {
          "matched": true,
          "userSearchFilterId": "sf_4hyqf0gyxveazss7nby5hve5x2",
          "userSearchFilterName": "Vintage Art Deco",
          "matchFeedback": true
        }
      }
    }
  ]
}

Changes

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property's min was decreased from 1.00 to 0.00 for the response status

    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • warning

      added the new DKK enum value to the /////////// response property for the response status

    • warning

      added the new DKK enum value to the ////////// response property for the response status

    • warning

      added the new DKK enum value to the ////////// response property for the response status

    • warning

      added the new DKK enum value to the /////////// response property for the response status

    • warning

      added the new DKK enum value to the ////////// response property for the response status

    • warning

      added the new DKK enum value to the ////////// response property for the response status

    • warning

      added the new HUF enum value to the /////////// response property for the response status

    • warning

      added the new HUF enum value to the ////////// response property for the response status

    • warning

      added the new HUF enum value to the ////////// response property for the response status

    • warning

      added the new HUF enum value to the /////////// response property for the response status

    • warning

      added the new HUF enum value to the ////////// response property for the response status

    • warning

      added the new HUF enum value to the ////////// response property for the response status

    • warning

      added the new INR enum value to the /////////// response property for the response status

    • warning

      added the new INR enum value to the ////////// response property for the response status

    • warning

      added the new INR enum value to the ////////// response property for the response status

    • warning

      added the new INR enum value to the /////////// response property for the response status

    • warning

      added the new INR enum value to the ////////// response property for the response status

    • warning

      added the new INR enum value to the ////////// response property for the response status

    • warning

      added the new KRW enum value to the /////////// response property for the response status

    • warning

      added the new KRW enum value to the ////////// response property for the response status

    • warning

      added the new KRW enum value to the ////////// response property for the response status

    • warning

      added the new KRW enum value to the /////////// response property for the response status

    • warning

      added the new KRW enum value to the ////////// response property for the response status

    • warning

      added the new KRW enum value to the ////////// response property for the response status

    • warning

      added the new MXN enum value to the /////////// response property for the response status

    • warning

      added the new MXN enum value to the ////////// response property for the response status

    • warning

      added the new MXN enum value to the ////////// response property for the response status

    • warning

      added the new MXN enum value to the /////////// response property for the response status

    • warning

      added the new MXN enum value to the ////////// response property for the response status

    • warning

      added the new MXN enum value to the ////////// response property for the response status

    • warning

      added the new NOK enum value to the /////////// response property for the response status

    • warning

      added the new NOK enum value to the ////////// response property for the response status

    • warning

      added the new NOK enum value to the ////////// response property for the response status

    • warning

      added the new NOK enum value to the /////////// response property for the response status

    • warning

      added the new NOK enum value to the ////////// response property for the response status

    • warning

      added the new NOK enum value to the ////////// response property for the response status

    • warning

      added the new RON enum value to the /////////// response property for the response status

    • warning

      added the new RON enum value to the ////////// response property for the response status

    • warning

      added the new RON enum value to the ////////// response property for the response status

    • warning

      added the new RON enum value to the /////////// response property for the response status

    • warning

      added the new RON enum value to the ////////// response property for the response status

    • warning

      added the new RON enum value to the ////////// response property for the response status

    • warning

      added the new SEK enum value to the /////////// response property for the response status

    • warning

      added the new SEK enum value to the ////////// response property for the response status

    • warning

      added the new SEK enum value to the ////////// response property for the response status

    • warning

      added the new SEK enum value to the /////////// response property for the response status

    • warning

      added the new SEK enum value to the ////////// response property for the response status

    • warning

      added the new SEK enum value to the ////////// response property for the response status

    • warning

      added the new THB enum value to the /////////// response property for the response status

    • warning

      added the new THB enum value to the ////////// response property for the response status

    • warning

      added the new THB enum value to the ////////// response property for the response status

    • warning

      added the new THB enum value to the /////////// response property for the response status

    • warning

      added the new THB enum value to the ////////// response property for the response status

    • warning

      added the new THB enum value to the ////////// response property for the response status

    • warning

      added the new TWD enum value to the /////////// response property for the response status

    • warning

      added the new TWD enum value to the ////////// response property for the response status

    • warning

      added the new TWD enum value to the ////////// response property for the response status

    • warning

      added the new TWD enum value to the /////////// response property for the response status

    • warning

      added the new TWD enum value to the ////////// response property for the response status

    • warning

      added the new TWD enum value to the ////////// response property for the response status

    • warning

      added the new ZAR enum value to the /////////// response property for the response status

    • warning

      added the new ZAR enum value to the ////////// response property for the response status

    • warning

      added the new ZAR enum value to the ////////// response property for the response status

    • warning

      added the new ZAR enum value to the /////////// response property for the response status

    • warning

      added the new ZAR enum value to the ////////// response property for the response status

    • warning

      added the new ZAR enum value to the ////////// response property for the response status

    • info

      added the new enum value DKK to the query request parameter currency

    • info

      added the new enum value HUF to the query request parameter currency

    • info

      added the new enum value INR to the query request parameter currency

    • info

      added the new enum value KRW to the query request parameter currency

    • info

      added the new enum value MXN to the query request parameter currency

    • info

      added the new enum value NOK to the query request parameter currency

    • info

      added the new enum value RON to the query request parameter currency

    • info

      added the new enum value SEK to the query request parameter currency

    • info

      added the new enum value THB to the query request parameter currency

    • info

      added the new enum value TWD to the query request parameter currency

    • info

      added the new enum value ZAR to the query request parameter currency

    • info

      added to the /// response property allOf list for the response status

    • info

      added the required property /// to the response with the status

    • warning

      removed the optional property //////// from the response with the status