Find items by name

Authentication: This method does not require authentication.

Summary

Find items by name.

Description

This API method retrieves array of items that contains query string in its names.

Query Parameters

name	type	data type	default	description
partner	required	string	N/A	partner id
query	optional	string	""	query to search
limit	optional	integer	20	limit of items
skip	optional	integer	0	offset of items

Response

The response data is an object with the following properties:

group: string: Name of item group
id: integer: Id of item
name: string: Name of item
price: integer: Price of working with the item
type: string: Item type (just "item")

Good Response example

{
  "status": "ok",
  "statusCode": 200,
  "data": [
    {
      "id": 10140,
      "name": "Small Furniture",
      "price": 20,
      "group": "Furniture",
      "type": "item"
    },
    {
      "id": 10132,
      "name": "Gaming Chairs",
      "price": 15,
      "group": "Furniture",
      "type": "item"
    },
    ...
  ]
}

Bad Response Examples

http code	response example
`422`	see 422 ValidationError

Last modified: 09 February 2024