get
/search
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
- mobile
- phone
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.
Authorization
apiKey - Authorization
Request Parameters
34 Query Parameters
Responses
Schema
data
array[object]
A collection of objects of one of the supported types: sales, products or customers.
Send a Test Request
GET
Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
domain_prefix
$$.env
1 variable not set
Authorization