Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

It is possible to link directly to search results. The following information outlines the process of composing such a link.

Every search results link starts in the same way:

http://YOUR_DOMAIN/products/search_results?

where YOUR_DOMAIN would be of form demo.titleleaf.com.

The guts of the search results link are defined by field/value pairs. A single field/value pair is of form:

search%5BFIELD_NAME%5D=VALUE
Field DescriptionField Name
Keywordsq
ISBNsproduct_formats_isbn_in
Contributors (eg, authors, illustrators)contributors_name_contains
BISAC codesbisac_subjects_code_in
Guided reading levelsguided_level_in
Minimum release dateproduct_formats_release_on_from
Maximum release dateproduct_formats_release_on_to
Catalog page numbercatalog_page_in
Product typetype_in
Minimum copyright yearproduct_formats_copyright_from
Maximum copyright yearproduct_formats_copyright_to
Product formatproduct_formats_format_id_in
Product statusproduct_formats_status_in
Dewey valuedewey_in
Minimum dewey rangedewey_from
Maximum dewey rangedewey_to
Minimum interest levelinterest_level_from
Maximum interest levelinterest_level_to
Minimum reading levelreading_level_from
Maximum reading levelreading_level_to
Minimum AR reading levelalsreadlevel_from
Maximum AR reading levelalsreadlevel_to
Minimum Lexilelexile_from
Maximum Lexilelexile_to
Series namecollection_name_contains
Minimum modified dateupdated_at_from
Maximum modified dateupdated_at_to
Product IDid_in
Proprietary product IDproprietary_id_in
Product formatproduct_formats_id_in
Publisherpublisher_name_equals
Imprintimprint_equals
Subjectcategories_id_in
Genregenres_contains
Languagelanguage_equals
Field DescriptionIntended Value
GenreBeginning reader
search%5Bgenres_contains%5D=beginning_reader

If the FIELD_NAME ends in "_in" or "_notin", use the following notation:

search%5BFIELD_NAME%5D%5B%5D=VALUE
Field DescriptionIntended Value
Product statusACT
search%5Bproduct_formats_status_in%5D%5B%5D=ACT
Field DescriptionIntended Value
SubjectScience

Note: Assuming the ID associated with the "Science" subject is 4.

search%5Bcategories_id_in%5D%5B%5D=4
Field DescriptionIntended Value
Minimum reading levelGrade 1
search%5Breading_level_from%5D=1
Field DescriptionIntended Value
Maximum reading levelGrade 3
search%5Breading_level_to%5D=3
Field DescriptionIntended Value
Product typeSet

Note: Internally, a "Set" is referred to as an "Assembly".

search%5Btype_in%5D=Assembly
Field DescriptionIntended Value
LanguageSpanish
search%5Blanguage_equals%5D=Spanish

Multiple field/value pairs are separated with an ampersand, &.

Field DescriptionIntended Value
GenreBeginning reader
SubjectScience
search%5Bgenres_contains%5D=beginning_reader&search%5Bcategories_id_in%5D%5B%5D=4
  • Spaces (and other characters) are not allowed in URLs. Use "+" instead of a space.
  • For translation of other characters, refer to W3Schools URL Encoding Reference

The sort order of the search results is defined by the following form:

order=CODE

where CODE can is limited to the values in the following table.

DescriptionCode
Name (A to Z)name
Name (Z to A)name_desc
Date Available (New to Old)date
Date Available (Old to New)date_desc
Series Name (A to Z)collection
Series Name (Z to A)collection_desc
Grade (Low to High)grade
Grade (High to Low)grade_desc
Popularity (High to Low)rate
Popularity (Low to High)rate_desc

The following link finds all products that are in the genre of "Beginning Reader" and in the subject of "Science". The results are sorted by name in descending order:

http://demo.titleleaf.com/products/search_results?order=name_desc&search%5Bgenres_contains%5D=beginning_reader&search%5Bcategories_id_in%5D%5B%5D=4

If you intend to use such a link in an email, it is highly recommended that you employ a URL shortening service such as Bitly.