Aura Historia · Schema

PatchUserSearchFilterData

Partial search filter update data. All fields are optional and nullable. Omitted or null top-level members leave the stored value unchanged. Nested search criteria use the null and omission rules in PatchProductListingSearchData. Can update the search filter name, notifications preference, activation state, and/or the search filter criteria.

CompanyAntiquesMarketplaceSearchSoftware-as-a-Service

Properties

Name Type Description
acceptShippingDestination object
name stringnull User-defined name for the search filter (max 255 characters, will be truncated if longer)
notifications booleannull Whether to enable or disable email notifications for new product-listings matching this search filter. When `true`, the user will be notified when a new product matches this filter. When `false`, no n
state object Optional activation state update for this saved search filter. `ACTIVE` reactivates the filter if the current user tier still permits the configured search features and quota. `INACTIVE_BY_USER` manua
search object Partial search filter criteria to update. Omit or supply null to leave all criteria unchanged.
View JSON Schema on GitHub

JSON Schema

aura-historia-com-patch-user-search-filter-data-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aura-historia-com/json-schema/aura-historia-com-patch-user-search-filter-data-schema.json",
  "title": "PatchUserSearchFilterData",
  "description": "Partial search filter update data.\nAll fields are optional and nullable. Omitted or null top-level members leave the stored value unchanged. Nested search criteria use the null and omission rules in PatchProductListingSearchData.\nCan update the search filter name, notifications preference, activation state, and/or the search filter criteria.\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aura-historia-com-search-filters-api-openapi.yml#/components/schemas/PatchUserSearchFilterData",
  "type": "object",
  "properties": {
    "acceptShippingDestination": {
      "anyOf": [
        {
          "$ref": "#/$defs/AcceptShippingDestinationData"
        },
        {
          "type": [
            "object",
            "null"
          ],
          "enum": [
            null
          ]
        }
      ]
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "User-defined name for the search filter (max 255 characters, will be truncated if longer)",
      "maxLength": 255
    },
    "notifications": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether to enable or disable email notifications for new product-listings matching this search filter.\nWhen `true`, the user will be notified when a new product matches this filter.\nWhen `false`, no notifications are sent for this filter.\nOmit or supply `null` to leave unchanged.\n"
    },
    "state": {
      "anyOf": [
        {
          "$ref": "#/$defs/PatchResourceStateData"
        },
        {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null
          ]
        }
      ],
      "description": "Optional activation state update for this saved search filter.\n`ACTIVE` reactivates the filter if the current user tier still permits the configured search features and quota.\n`INACTIVE_BY_USER` manually disables the filter.\nOmit or supply `null` to leave the current state unchanged.\n"
    },
    "search": {
      "anyOf": [
        {
          "$ref": "#/$defs/PatchProductListingSearchData"
        },
        {
          "type": [
            "object",
            "null"
          ],
          "enum": [
            null
          ]
        }
      ],
      "description": "Partial search filter criteria to update. Omit or supply null to leave all criteria unchanged."
    }
  },
  "$defs": {
    "AcceptShippingDestinationData": {
      "description": "Explicit create/PATCH acceptance guard. The authored search.shipping destination country must equal the authorized owned address or selected preference's submitted country (or subdivision country). No selection, missing asserted country or mismatch is BAD_BODY_VALUE. Ownership/current-account rules apply; delegated callers additionally require users:read. Only the country value/reference/interpretation is saved; postal, street, provider evidence and mutable references are discarded. Later address/preference edits or deletion never move a saved predicate. Omission accepts the authored country directly. No preference is changed.",
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "addressId"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "ADDRESS"
              ]
            },
            "addressId": {
              "$ref": "#/$defs/UserAddressId"
            }
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "PREFERENCE"
              ]
            }
          }
        }
      ]
    },
    "CurrencyData": {
      "type": "string",
      "enum": [
        "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",
        "ARS"
      ],
      "description": "Supported currencies (ISO 4217 codes):\n- EUR: Euro\n- GBP: British Pound\n- USD: US Dollar\n- AUD: Australian Dollar\n- CAD: Canadian Dollar\n- NZD: New Zealand Dollar\n- CNY: Chinese Yuan\n- BRL: Brazilian Real\n- PLN: Polish Złoty\n- TRY: Turkish Lira\n- JPY: Japanese Yen\n- CZK: Czech Koruna\n- RUB: Russian Ruble\n- AED: UAE Dirham\n- SAR: Saudi Riyal\n- HKD: Hong Kong Dollar\n- SGD: Singapore Dollar\n- CHF: Swiss Franc\n- ZAR: South African Rand\n- SEK: Swedish Krona\n- DKK: Danish Krone\n- NOK: Norwegian Krone\n- KRW: South Korean Won\n- INR: Indian Rupee\n- TWD: New Taiwan Dollar\n- HUF: Hungarian Forint\n- RON: Romanian Leu\n- MXN: Mexican Peso\n- THB: Thai Baht\n- ARS: Argentine Peso (2 minor-unit decimal places)\n",
      "default": "EUR"
    },
    "GeographicOriginData": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "latitude",
        "longitude"
      ],
      "description": "Explicit finite numeric WGS 84 coordinates in degrees; no text, address or preference resolution.",
      "properties": {
        "latitude": {
          "type": "number",
          "minimum": -90,
          "maximum": 90
        },
        "longitude": {
          "type": "number",
          "minimum": -180,
          "maximum": 180
        }
      }
    },
    "GeographicRadiusData": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "amount",
        "unit"
      ],
      "description": "Finite positive radius in the supplied unit, equivalent to at most 20000 kilometres. The supplied amount and unit are preserved in private saved-filter snapshots.",
      "properties": {
        "amount": {
          "type": "number",
          "exclusiveMinimum": 0
        },
        "unit": {
          "type": "string",
          "enum": [
            "KILOMETERS",
            "MILES",
            "METERS",
            "YARDS",
            "FEET",
            "INCHES",
            "CENTIMETERS",
            "MILLIMETERS",
            "NAUTICAL_MILES"
          ]
        }
      }
    },
    "GeographicSearchData": {
      "type": "object",
      "additionalProperties": false,
      "description": "At least one country, subdivision, radius or distance order is required. Sets are OR; distinct geographic predicates are AND. Subdivisions must belong to a supplied country when countries is nonempty. Absence excludes a result. Radius and ordering require an explicit numeric origin; an origin or approximate mode without proximity is invalid. Strict proximity admits PREMISES only; approximate also admits STREET, LOCALITY and REPRESENTATIVE. Distance ordering is incompatible with the existing sort. Saved filters retain a private immutable snapshot until replaced.",
      "properties": {
        "countries": {
          "type": "array",
          "maxItems": 100,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "pattern": "^[A-Z]{2}$"
          }
        },
        "subdivisions": {
          "type": "array",
          "maxItems": 100,
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "origin": {
          "$ref": "#/$defs/GeographicOriginData"
        },
        "radius": {
          "$ref": "#/$defs/GeographicRadiusData"
        },
        "mode": {
          "type": "string",
          "enum": [
            "STRICT",
            "APPROXIMATE"
          ],
          "default": "STRICT"
        },
        "distanceOrder": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "LanguageData": {
      "type": "string",
      "enum": [
        "de",
        "en",
        "fr",
        "es",
        "it",
        "zh",
        "pt",
        "pl",
        "tr",
        "nl",
        "cs",
        "ja",
        "ru",
        "ar"
      ],
      "description": "Supported language codes (ISO 639-1 canonical values):\n- de: German (includes de-DE, de-AT, de-CH, de-LU, de-LI)\n- en: English (includes en-US, en-GB, en-AU, en-CA, en-NZ, and backend-specific accepted alias en_IE)\n- fr: French (includes fr-FR, fr-CA, fr-BE, fr-CH, fr-LU)\n- es: Spanish (includes es-ES, es-MX, es-AR, es-CO, es-CL, es-PE, es-VE)\n- it: Italian (includes it-IT, it-CH)\n- zh: Chinese (Simplified) (includes zh-CN, zh-Hans)\n- pt: Portuguese (includes pt-PT, pt-BR)\n- pl: Polish (includes pl-PL)\n- tr: Turkish (includes tr-TR)\n- nl: Dutch (includes nl-NL, nl-BE)\n- cs: Czech (includes cs-CZ)\n- ja: Japanese (includes ja-JP)\n- ru: Russian (includes ru-RU)\n- ar: Arabic (includes ar-SA, ar-EG, ar-AE)\n\n`de`, `en`, `fr`, `es`, and `it` are fully supported localization/translation-target languages.\n`zh`, `pt`, `pl`, `tr`, `nl`, `cs`, `ja`, `ru`, and `ar` are ingestion-only languages:\nthey can appear in stored/native content and are accepted anywhere `LanguageData` is used,\nbut backend-generated translations and fallback localized strings are not produced in these languages.\n",
      "default": "en"
    },
    "ListingAvailabilityData": {
      "type": "string",
      "enum": [
        "AVAILABLE",
        "IN_STOCK",
        "LIMITED_AVAILABILITY",
        "BACK_ORDER",
        "MADE_TO_ORDER",
        "PRE_ORDER",
        "PRE_SALE",
        "UNAVAILABLE",
        "RESERVED",
        "OUT_OF_STOCK",
        "SOLD_OUT"
      ],
      "description": "Current reliable source assertion of listing purchase availability. Omitted or `null` means Aura has no reliable current assertion."
    },
    "ListingOrderabilityData": {
      "type": "string",
      "enum": [
        "ORDERABLE_NOW",
        "ORDERABLE_CONDITIONALLY",
        "NOT_ORDERABLE"
      ],
      "description": "Broad classification derived from a concrete availability assertion; it is not independently stored."
    },
    "PatchProductListingSearchData": {
      "type": "object",
      "description": "Partial ProductListing search criteria. Omitted fields are unchanged. `enhancedSearchDescription`, `auctionId`, price, date ranges, and the availability query may be cleared with `null`; availability, orderability, and includeUnspecifiedAvailability` must be supplied together or all be `null`.",
      "properties": {
        "shipping": {
          "anyOf": [
            {
              "$ref": "#/$defs/ShippingSearchData"
            },
            {
              "type": [
                "object",
                "null"
              ],
              "enum": [
                null
              ]
            }
          ],
          "description": "Complete shipping predicate. Omit to leave unchanged in PATCH; null clears it. Saved country values pin their reference release and interpretation independently of browsing preferences."
        },
        "language": {
          "$ref": "#/$defs/LanguageData"
        },
        "currency": {
          "$ref": "#/$defs/CurrencyData"
        },
        "productQuery": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "enhancedSearchDescription": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "maxLength": 1000
        },
        "listingSourceId": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "uniqueItems": true,
          "description": "ListingSource IDs to include."
        },
        "excludeListingSourceId": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "uniqueItems": true,
          "description": "ListingSource IDs to exclude."
        },
        "auctionId": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "uniqueItems": true,
          "maxItems": 100,
          "description": "Exact resolved Auction membership IDs. Values use strict `auc_` TypeIDs and OR together."
        },
        "price": {
          "allOf": [
            {
              "$ref": "#/$defs/RangeQueryUInt64"
            }
          ]
        },
        "availability": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/ListingAvailabilityData"
          },
          "uniqueItems": true
        },
        "orderability": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/ListingOrderabilityData"
          },
          "uniqueItems": true
        },
        "includeUnspecifiedAvailability": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "created": {
          "allOf": [
            {
              "$ref": "#/$defs/RangeQueryDateTime"
            }
          ]
        },
        "updated": {
          "allOf": [
            {
              "$ref": "#/$defs/RangeQueryDateTime"
            }
          ]
        },
        "lotBiddingOpens": {
          "allOf": [
            {
              "$ref": "#/$defs/RangeQueryDateTime"
            }
          ]
        },
        "lotScheduledCloses": {
          "allOf": [
            {
              "$ref": "#/$defs/RangeQueryDateTime"
            }
          ]
        },
        "geography": {
          "allOf": [
            {
              "$ref": "#/$defs/GeographicSearchData"
            }
          ],
          "description": "Omitted leaves the private snapshot unchanged; null clears; an object replaces the complete geography predicate."
        }
      }
    },
    "PatchResourceStateData": {
      "type": "string",
      "description": "Client-settable activation state for resources that support manual activation toggles.\nClients may reactivate a resource with `ACTIVE` or manually disable it with `INACTIVE_BY_USER`.\n`INACTIVE_BY_RESTRICTED_PLAN` is managed internally by the backend and is never accepted from clients.\n",
      "enum": [
        "ACTIVE",
        "INACTIVE_BY_USER"
      ]
    },
    "RangeQueryDateTime": {
      "type": "object",
      "description": "Range query for date and time values",
      "properties": {
        "min": {
          "type": "string",
          "format": "date-time",
          "description": "Minimum date and time (inclusive, RFC3339 format)"
        },
        "max": {
          "type": "string",
          "format": "date-time",
          "description": "Maximum date and time (inclusive, RFC3339 format)"
        }
      }
    },
    "RangeQueryUInt64": {
      "type": "object",
      "description": "Range query for numeric values in minor currency units for the selected indexed currency; no request-time conversion occurs",
      "properties": {
        "min": {
          "type": "integer",
          "minimum": 0,
          "description": "Minimum value (inclusive)"
        },
        "max": {
          "type": "integer",
          "minimum": 0,
          "description": "Maximum value (inclusive)"
        }
      }
    },
    "ShippingSearchData": {
      "type": "object",
      "additionalProperties": false,
      "description": "AND predicates over the supported definite whole-country projection. Country, service, currency and per-item amount must belong to one offer. Fixed and explicitly denominated free PER_ITEM rates support an inclusive maximum; free is zero. FROM, estimated, external, requested, absent and differently based prices cannot satisfy a maximum. Postal/variant/cart uncertainty cannot become a definite country match. Missing offers do not mean unavailable or collection-only. No query changes the browsing preference; returned shipping still uses current PostgreSQL authority. Omitted destination selects no country. NONE alone disables shipping filtering (clears it in PATCH); otherwise a country or collectionOffered=true is required. Service and maximum require a country. Shipping observation age imposes no expiry.",
      "properties": {
        "destination": {
          "oneOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "kind",
                "country"
              ],
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "COUNTRY"
                  ]
                },
                "country": {
                  "type": "string",
                  "pattern": "^[A-Z]{2}$",
                  "description": "Current ISO 3166-1 alpha-2 country in the pinned release."
                }
              }
            },
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "kind"
              ],
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "NONE"
                  ]
                }
              }
            }
          ]
        },
        "referenceRelease": {
          "type": "string",
          "enum": [
            "iso-codes-4.20.1"
          ],
          "default": "iso-codes-4.20.1"
        },
        "interpretation": {
          "type": "string",
          "enum": [
            "WHOLE_COUNTRY_PER_ITEM_V1",
            "WHOLE_COUNTRY_PER_ITEM_FX_V1"
          ],
          "default": "WHOLE_COUNTRY_PER_ITEM_V1",
          "description": "Default compares advertised source currency. FX_V1 requires maximumPerItem and compares HalfUp converted amounts in its target currency using the persisted browsing snapshot, pinned across continuation."
        },
        "service": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "description": "Exact advertised service code; requires a destination country."
        },
        "maximumPerItem": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "amount",
            "currency"
          ],
          "description": "Inclusive per-item charge in minor units. Currency is the advertised source currency by default, or the explicit target under FX_V1, independently of browsing display currency. Only fixed/known-currency free per-item offers match. No purchase quantity or complete landed cost is implied.",
          "properties": {
            "amount": {
              "type": "integer",
              "format": "int64",
              "minimum": 0,
              "maximum": 9223372036854775807,
              "description": "Inclusive maximum in minor units."
            },
            "currency": {
              "$ref": "#/$defs/CurrencyData"
            }
          }
        },
        "collectionOffered": {
          "type": "boolean",
          "default": false,
          "description": "True requires independently definite offered collection. False adds no collection constraint."
        }
      }
    },
    "UserAddressId": {
      "type": "string",
      "pattern": "^uaddr_[0-7][0-9a-hjkmnp-tv-z]{25}$",
      "description": "Strict server-generated UUIDv7 UserAddress TypeID, returned on creation. No bare UUID or owner input."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/aura-historia-com-patch-user-search-filter-data"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.