Skip to content

Product

Endpoints for retrieving products.

Operations

Get All Products

Request

Security
ApiKeyAuth
Query
limitinteger, [ 1 .. 100 ]

The number of results to return (default 10).

Default:10
offsetinteger, >= 0

The page number for pagination (default 0). This is multiplied by limit to get the actual offset.

Default:0
orderstring

Sorting property (default sort is by www update date). Multiple sorts can be supplied by comma concatenation.

Default:"wwwUpdateDate"
Enum:"wwwUpdateDate""title"
Example:order=wwwUpdateDate,title
orderDirectionstring

Sorting direction (default is "desc"). Multiple directions can be defined for multiple sorts.

Default:"desc"
Example:orderDirection=desc,asc
productIdstring

Filter by product identifier.

categorystring

Filter by product category.

curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/products?limit=10&offset=0&order=wwwUpdateDate%2Ctitle&orderDirection=desc%2Casc&productId=string&category=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
dataArray of objects(product)
paginationobject
Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "total": 256,
    "has_more": true
  }
}