Search through products.

Title: Search through products.

Search and get product data from a product database. Search with multiple filters.

Each filter contains field name, lookup expression and value.

In general filter looks like

{"title": {"lookup": "contains", "value": "Apple MacbookPro 15'"}}

Filter fields: 1. Text fields: * any * search_field * title * brand * description * category * currency * id * offer_id * feed_id * status 2. Numeric fields: * price * sale_price * discount * cpc_rate * is_cpc 3. Date fields: * updated_at

Filter field lookups: 1. Text field lookups: * contains * exact * starts_with * phrase * dis_max 2. Numeric field lookups: * exact * lt * gt * range 3. Date field lookups: * lt * gt * range

Filter value - could be single value or array of values. In case of array values OR subfilter is applied.

Nagation filter is build with ~ symbol, like ~contains means doesn't contain.

Additionally, website key queryparam could be used for product tracking link autogeneration.

Example:

{
    "filters": [
        {"title": {"lookup": "contains", "value": "konsola"}},
        {"brand": {"lookup": "contains", "value": ["Xbox", "Sony playstation"]}},
        {"title": {"lookup": "~contains", "value": ["gra", "controller"]}},
        {"price": {"lookup": "gt", "value": 1000}},
        {"discount": {"lookup": "~lt", "value": 10}}
    ],
    "page": 1,
    "page_size": 100,
    "ordering": "-score"
}

Request

POST https://api.convertiser.com/publisher/products/v2/

Path parameters

Parameter name Value Description Additional
key string

Website key

Request body

The request body takes a complete Undefined resource, containing the following writable properties:

{
    "filters": [
        "string"
    ],
    "ordering": "string",
    "page": "integer",
    "page_size": "integer"
}

Properties

Name Type Description Additional
filters[] array of string

Product filters

 Optional
ordering string

Ordering

 Optional
page integer

Page number

 Optional
page_size integer

Page size

 Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Explore this API

key

Website key
data
Request Content-Type
Response Content-Type

Choose an authorisation method:

API Token API Token to be used for request
Try it out!