Developers



  • General
    • Pagination
    • Searching and Ordering
  • Product
    • Introduction
    • Category
    • Product
    • Product Composition
    • Brand
    • Popup Note
    • Tax Rate
    • Multiple Choice Note
    • Multiple Choice Option
    • Multiple Choice Product
    • Multiple Choice Product Group
    • Multiple Choice Product Group Item
    • Product Location Area Price
  • Customer
    • Introduction
    • Customer
    • Customer Address
    • Customer Type
    • Customer Rating
    • Customer Credit
    • Customer Points
  • Booking
    • Introduction
    • Booking
    • Booking Customer
    • Booking Item
  • Stock Control
    • Introduction
    • Product Stock
    • Stock Transfer
    • Stock Transfer Item
    • Stock Transfer Reason
    • Purchase Order
    • Purchase Order Item
    • Supplier
    • Location
    • Location Area
  • Transaction
    • Introduction
    • Transaction
    • Transaction Item
    • Tender
    • Tender Type
    • Base Item
    • Preparation Status
    • Transaction Details
    • Discount Reason
    • Complete Transaction
    • Seating Area
    • Seating Table
  • Staff
    • Introduction
    • Staff
    • AccessRight
    • Clocking
    • ClockingType
  • Reports
    • End Of Day Report
    • Daily Sales Report
    • Bookkeeping Report
  • Other
    • Device
    • End Of Day
Developers
  • Home
  • Setup
  • Documentation
    • V2
    • V4
  • Examples
  • Support
  • Search

Searching and Ordering


Search for a Item by specific property value

To retrieve one or more specific Item, use:

GET https://api.eposnowhq.com/api/V2/{ItemName}?{PropertyName}={Value}

Url params
{ItemName} Item Name: e.g. Customer,Product
{PropertyName} Property Name: e.g. Name,Description
{Value} Property Value: e.g. Smith,Tea
Response
... List of Items matching request parameters

Search for the Items by property value or range

The API V2 allows you to search for a specific value or range of properties
Allowed Queries

like, contains GET https://api.eposnowhq.com/api/V2/{ItemName}?search=(propertyName|like|value)
GET https://api.eposnowhq.com/api/V2/{ItemName}?search=(propertyName|contains|value)
> GET https://api.eposnowhq.com/api/V2/{ItemName}?search=(propertyName|>|value)
>= GET https://api.eposnowhq.com/api/V2/{ItemName}?search=(propertyName|>=|value)
< GET https://api.eposnowhq.com/api/V2/{ItemName}?search=(propertyName|<|value)
<= GET https://api.eposnowhq.com/api/V2/{ItemName}?search=(propertyName|<=|value)
EndsWith GET https://api.eposnowhq.com/api/V2/{ItemName}?search=(propertyName|EndsWith|value)
StartsWith GET https://api.eposnowhq.com/api/V2/{ItemName}?search=(propertyName|StartsWith|value)
Url params
{ItemName} The name of the item: e.g. Customer,Product
propertyName The item property name: e.g. Name,Description,Price
value The property value

Order results by property value

To order your results ascendingly by a specific property, use:

https://api.eposnowhq.com/api/V2/{ItemName}?OrderBy={Property_Name}

Url params
{Property_Name} Property name: e.g. Name,Price
Response
... List of Items ordered ascendingly by the request parameter
To order your results descendingly by a specific property, use:

https://api.eposnowhq.com/api/V2/{ItemName}?OrderByDesc={Property_Name}

Url params
{Property_Name} Property name: e.g. Name,Price
Response
... List of Items ordered descendingly by the request parameter

EposNow
About Us
Contact Us
Documentation
API V2
API V4
Example Apps
Specials Board






© 2025 - Epos Now Ltd, Developers