Definition
Authorization
In this API call you must use the following authorization access and permissions:
| Available access type | Permissions needed |
|---|---|
| Private access | Catalogs -> Get catalog item |
Read more about:
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| projectToken | string | The ID of your project. | Required |
| catalogId | string | The ID of the desired existing catalog. | Required |
| itemId | string | The ID of the desired item in the specified catalog. | Required |
Query Parameters
| Parameter | Description | Example | Required |
|---|---|---|---|
| query | Query string to match the desired catalog's item properties and item_id. | ?query=Apple | No |
| field | Further refine your query. If used, the query will be matched only against the specified field. Works only with indexed catalog columns. | ?field=manufacturer | No |
| count | How many items should be returned. Default value 20. | ?count=50 | No |
| skip | How many items should be skipped. Default value 0. Count + skip shouldn't be > 1001, otherwise status code 400 will be returned. | ?skip=100&count=10 | No |
| order | By which column and how should be the result ordered. Format: | ?order=price%20desc,manufacturer%20asc | No |
Header
| Parameter | Type | Description | Required |
|---|---|---|---|
| authorization | string | Used for authentication. Read more in the Authentication section. | Required |
| content-type | string | application/json | Required |
Response description
| Attribute | Type | Description |
|---|---|---|
| data | array of objects | List of objects representing the individual retrieved rows. |
| limit | number | Number of items retrieved in this pagination page. |
| matched | number | Number of items matching the search query. |
| matched_limited | boolean | Value is always false. (Deprecated: If true there were too many items that matched the query, therefore the number of matched items provided above is the lower bound, not the exact number.) |
| skip | number | Number of skipped records in this pagination. |
| total | number | Total number of items in this catalog. |
| success | boolean | Result status. If false, there is errors object with description. |
Data object description
| Attribute | Type | Description |
|---|---|---|
| catalog_id | string | Catalog unique identifier |
| item_id | string | Item unique identifier |
| properties | object | Actual item fields and values. |
Limitations
You can retrieve only 1001 items using paging. When using count and skip query parameters, count + skip should not be greater than 1001, otherwise, the 404 status code will be returned.