Back to All
added

2019-10 New Search Endpoint and java-sdk

over 4 years ago by ReadMe API

Search endpoint

We have heard from a lot of API users that listing all resources in the default order wasn't enough in some cases. Integrators asked for the ability to list and filter resources in ways that better suit their specific use cases.

We are happy to announce that in response to this feedback we have produced a new search endpoint.

This endpoint allows integrators to search all of the most commonly used resources, sales, products and customers. Each type allowing search by a number of different parameters.

Supported resource types and attributes

  • Sales
    • date_from
    • date_to
    • status
    • invoice_number
    • customer_id
    • user_id
    • outlet_id
  • Products
    • sku
    • supplier_id
    • brand_id
    • tag_id
    • product_type_id
    • variant_parent_id
  • Customers
    • customer_code
    • first_name
    • last_name
    • company_name
    • phone
    • mobile
    • email

Sorting and pagination

Unlike other endpoints in the API 2.0, search results from this endpoint can be sorted by any of the attributes above. Because of that, the default pagination mechanism is not appropriate for this endpoint. Instead, this endpoint uses offset and page_size attributes to handle search results spanning multiple pages.

Detailed reference documentation is available here.

Java SDK for API 2.0

Today we're also announcing the availability of the first beta release of the Java SDK for the API 2.0. Our work on SDKs (yes, there are more coming...) is aimed at lowering the effort required to start using the API. We're starting with Java as that seems to be the environment that we get asked about most often.

While we're really excited to make this available to everyone, we need to caution you that this is the initial release of this package and it is most likely not ready for production use. We encourage everyone working with Java to give this library a try and provide us with any feedback.
We're looking forward to the invaluable input from users, which should help us to make this library rock solid. The best way to provide the feedback is by creating issues on the SDK repository on GitHub and if you have any questions as always please direct them at [email protected].

This SDK is auto-generated based on the OAS (Swagger) specification which is also available on GitHub.