Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Products

search products

This API searches product by email or phone or name and returns list of matched products.

get/products/search

Query parameters

namestring

search products by name. The search string should be a substring of the name. Many products may be found

referencestring

search products by product reference. The search string should be a substring of the reference. Many products may be found

Response

returns list of found products.

idstring uuid

unique uuid of the product

namestring required

product name

referencestring

product reference

descriptionstring

product description

normalPricenumber double

product normal price

promoPricenumber double

product promotion price

wholesalePricenumber double

product normal price

taxCode'taxCode1' | 'taxCode2' | 'taxCode3' | 'taxCode4' | 'taxCode5'

tax to add to the price in percentage. value of taxCodeX depends to your country. taxCode1 is the lowest tax applicable in your country, taxCode2 is the following. If no tax exist in your country, select taxCode0, its value will be zero. If three types of tax only exits in country, ignore taxCode4 and taxCode5. Tax values can ge retrieved by calling /product-management/taxes?country={your_country_code}

categorystring

product category.

imageUrlstring

product image url

updatedAtstring

The date time that record was updated in our system.

createdAtstring

The date time that record was created in our system.

Example response

[
  {
    "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "name": "pineapple",
    "reference": "SKU56789002",
    "description": "Sweet senegalese pineapple",
    "normalPrice": 100,
    "promoPrice": 90,
    "wholesalePrice": 70,
    "taxCode": "taxCode1",
    "category": "fruits",
    "imageUrl": "https://example.com/products/images/pineapple.jpeg",
    "updatedAt": "2022-06-20T17:17:11Z",
    "createdAt": "2022-06-20T17:17:11Z"
  }
]