Get item list

Authentication: This method does not require authentication.

Summary

Get list of all items

Description

This API method retrieves the list of all items.

Also, you can get item list with searching by name: see Find items by name

You must use item id to make your order.

Query Parameters

name	type	data type	default	description
partner	required	string	N/A	partner id

Response

The response data is an array of the objects with follow properties:

name: string

Name of item

type: string

Type of item. May be group and item.

children: integer

Groups always contains this property. It is an array of object with follow properties:

id: number. This is item id. You need to pass it to methods Create new partner order and Get cost of order by details
name: string. This is name of the item.
price: integer. This is a price of the item.
type: string. Type of item, item or group.

Good Response example

{
  "status": "ok",
  "statusCode": 200,
  "data": [
    {
      "children": [
        {
          "id": 10122,
          "type": "item",
          "name": "Wardrobes 1-2 doors",
          "price": 40
        },
        {
          "id": 10123,
          "type": "item",
          "name": "Wardrobes 3-4 doors",
          "price": 60
        },
        ...
      ],
      "type": "group",
      "name": "Furniture"
    },
    ...
  ]
}

Bad Response Examples

http code	response example
`422`	see 422 ValidationError

Last modified: 09 February 2024