go back to CustomerService

GET /customers/search

Searches the database for customers matching the given request parameters.

Roles that can access this endpoint are Users.

Parameters

name description type default type
request read for query parameters to be used as search criteria; use any combination of fields from the customer table using a prefix of customer or no prefix.
For example, /customers/search?customer.is_active=Y&customer.name=mc*&customer.last_ship_date=>=t-100 would find active customers having a name that starts with 'mc' who shipped something in the last 100 days.

Sorting: To sort the result set, you can provide the following reserved query parameter: orderBy If the orderBy parameter is not provided a default sort of customer.id+DESC will be applied.

For example, /customers/search?customer.id=*&orderBy=customer.name+DESC would return all customer records sorted descending by the customer name. Multiple sort columns can be provided in a comma delimited format. orderBy=prefix.field+direction,prefix.field+direction

Pagination: To page the result set, you can provide the following reserved query parameters: recordLength and recordOffset

For example, /customers/search?customer.id=*&recordLength=100&recordOffset=50 would return 100 records starting at the 51st record in the return record set. If no recordLength parameter is provided the search result maximum value in the mobile service control file will be applied.

context HttpServletRequest

Result

List < RowCustomer > of type: application/xml application/json

a list of customer objects

Try It Out

Request

- Authentication Help