How to obtain a list of item images

Item images can be retrieved by using the following URL.  Up to 100,000 records will be returned, but no limits can be set.  Items are returned in order of item lot, item lot suffix, then item ID, image order.

 

 Method URL
 GET  https://api.fairwarningsoftware.com/v1.1.1/items/images

 

 Status Response
 200

 {"items":[
    {
        "item_id": {
            <image_name>,
            <image_name>,
            ....
        },
        ....
    }
]}
401  {"error":"The API keys provided are invalid."}
403  {"error":"API keys are missing."}
500  {"error": <custom error>}

 

 Field  Type Description
item_id int The unique identifier for the item
image_name string The name of the image

 

To sort, you can specify a "sort_by" object in the JSON using any field that is searchable, and specifying whether to sort it "asc" or "desc".

{ "sort_by" : { <field_name> : <sort_direction>,  "item_lot" : "asc",  "item_lot_suffix" : "asc" } }

You may also choose to search the items in order to retrieve more specific results.  For instance, if you are only looking for items in a certain primary category, you could pass query parameters to specify the primary category ID you want the auction results to belong to.

{ "category_id_1": { "operator" : "equals", "value": 59 } }

By passing this data string as raw post data, you will limit your results to only items that belong to the primary cateogory with the cateogory ID of 59.

You may also wish to only get a list of items that are at an office with an ID of 82 that belong to cateogory 59.  In that case, you could add a second parameter to your search like so:

{ "category_id_1": { "operator" : "equals", "value": 59 }, "office_id": { "operator" : "equals", "value": 82 } }

In this way, you will limit the search results to both the category ID and the office ID.

Below is a list of search fields that you can perform a full text search on:

  • item_title
  • item_description
  • item_condition
  • item_provenance

To search on a field for values which match a given set of values, use the "in" operator.  The value should be an array of values in which the search results should match.

{"office_id" : { "operator" : "in", "value" : [13, 18, 10]}}

 To search on a field for multiple filters, the JSON value of the filter should be a listing of values.

{ "item_lot":[ { "operator":"greater_than_equal","value":1 }, { "operator":"less_than_equal","value":10 } ] }