robotrunk.com

{
  "type": "object",
  "properties": {
    "merchant": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 100,
      "description": "Null searches every store RoboTrunk offers: usually what you want. A slug from /agent/merchants searches that one store. Example: \"anbbaby-com\", a slug, never a store name or a link."
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 300,
      "description": "The want in the person's own words, as a sentence: the thing, what it must do, any constraints. A model reads this. Never a keyword."
    },
    "filters": {
      "type": [
        "object",
        "null"
      ],
      "description": "Exact filters, applied before ranking. What you set here beats what the model inferred. Null lets the sentence decide. Example: {\"max_price_minor\": 25000, \"currency\": \"USD\", \"in_stock_only\": true} is USD 250.00 or less, in stock.",
      "properties": {
        "max_price_minor": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "description": "Inclusive upper bound in the currency's smallest unit, so 25000 is 250.00. Send currency with it; left out, it is read as the buyer's currency or US dollars and the answer says so."
        },
        "min_price_minor": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "description": "Inclusive lower bound in the currency's smallest unit. Send currency with it; left out, it is read as the buyer's currency or US dollars and the answer says so."
        },
        "currency": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^[A-Z]{3}$",
          "description": "The ISO currency both price bounds are in. Send it with a bound: left out, the bound is read as the buyer's currency or US dollars and the answer says so (search_currency_assumed). Products priced in any other currency are left out."
        },
        "in_stock_only": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "True removes products the store says are sold out. Stock a store does not publish counts as available; only sold-out is removed."
        },
        "merchant_slug": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "description": "One store, the same effect as naming it in merchant."
        }
      },
      "additionalProperties": false
    },
    "limit": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 30,
      "description": "How many candidates the ranking model reads. Site-wide: 10 to 30, and 20 when null. Store-scoped: 1 to 20."
    },
    "cursor": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "description": "The next page of the same candidate set, from a previous answer's resource.cursor. Held for fifteen minutes."
    },
    "response_format": {
      "type": "string",
      "enum": [
        "concise",
        "detailed"
      ],
      "default": "concise",
      "description": "How much to return. `concise` is the default when null: acting fields plus source_retailer and price_may_differ. `detailed` adds the source block."
    },
    "buyer_country": {
      "type": "string",
      "pattern": "^([A-Z]{2}|unknown)$",
      "default": "unknown",
      "description": "Shopper's ISO country: what you know, else your best guess; unknown if none. Left out, it is read as unknown and the answer asks you to send it. Example: \"AU\", \"US\" or \"unknown\", never a country name."
    },
    "buyer_country_basis": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "known",
        "guessed",
        null
      ],
      "description": "Optional, with buyer_country: known if you know the country, guessed if it is your best guess. Null if neither."
    },
    "buyer_postcode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 12,
      "description": "Site-wide only, with buyer_country: postcode the person has said, used only to price shipping and never stored. Null when not said; never guess."
    },
    "shopping_session_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
      "description": "Optional server-issued shopping session correlation ID. It is not purchase authority."
    }
  },
  "required": [
    "merchant",
    "query",
    "filters",
    "limit",
    "cursor",
    "response_format"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "merchant": {
            "type": "string"
          }
        },
        "required": [
          "merchant"
        ]
      },
      "then": {
        "properties": {
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 20
          },
          "filters": {
            "type": "null"
          },
          "cursor": {
            "type": "null"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "merchant": {
            "type": "null"
          }
        }
      },
      "then": {
        "properties": {
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 10,
            "maximum": 30
          }
        }
      }
    }
  ]
}