---
title: "Search the Product Inventory"
method: GET
path: "/inventory"
tags: ["Product Inventory"]
---

# Search the Product Inventory

`GET /inventory`

## Request

- Base URL: `https://resources.uk.eagleeye.com`
- URL: `https://resources.uk.eagleeye.com/inventory`
- Auth: none declared. Required headers: `X-EES-AUTH-CLIENT-ID`, `X-EES-AUTH-HASH`

This API endpoint allows the calling application to retrieve a list of Products based on a number of parameters.

Below is a list of the 5 combinations of parameters that can be be passed in to filter the returned Products:
 * groupReference & parentIncomingIdentifier.
 * upc & parentIncomingIdentifier.
 * sku & parentIncomingIdentifier.
 * parentIncomingIdentifier & tag & matchAll.
 * parentIncomingIdentifier & name.

## Query parameters

- `groupReference` string, string
- `incomingIdentifier` string, string
- `upc` string, string
- `sku` string, string
- `tag` string, string
- `name` string, string
- `supplierId` string, string
- `supplierName` string, string
- `brand` string, string
- `brandType` string, string
- `lastSoldDate` string, ees-date-time
- `matchAll` boolean
- `parentIncomingIdentifier` string, string

## Headers

- `Accept-Encoding` '''' | ''gzip'' | ''deflate'' | ''gzip,deflate'' | ''deflate,gzip'', string
- `Connection` 'keep-alive' | 'close', string
- `Content-Type` string, string
- `X-EES-AUTH-CLIENT-ID` string, string, required
- `X-EES-AUTH-HASH` string, string, required
- `X-EES-TRANSACTION-ID` string, string

## Response `200`

EES AIR has successfully processed a Request

- object
  - `offset` integer, required: Result set pagination offset
  - `limit` integer, required: Results per page (up to 100)
  - `total` integer, required: Results count
  - `orderBy` object[], nullable, required
    - `name` string, string: Field used for sorting results
    - `order` 'ASC' | 'DESC', string: Sorting order (ascending, descending)
  - `results` ProductInventoryListEntity[], required
    - `sku` string, string, nullable: Product SKU.
    - `upc` string, string, nullable: Product UPC.
    - `name` string, string: Product Name.
    - `description` string, string: Product Description.
    - `image` string, string: Product Image.
    - `supplierId` string, string: Product Supplier ID.
    - `supplierName` string, string: Product Supplier Name.
    - `brand` string, string: Product Brand Name.
    - `brandType` string, string: Product Brand Name.
    - `lastSoldDate` string, ees-date-time, nullable: Product Last Sold Date-Time (ATOM format).
    - `tags` string[]: List of Product tags.
    - `groups` object[]: List of groups that the Product belongs to.
      - `reference` string, string: The Product Group's Reference.
      - `groupReference` string, string: The Product Group's Group Reference.
      - `name` string, string: The Product Group's Name.
      - `primary` integer: The Product Group's Primary Value.

## Other responses

- `400`: EES AIR Refuse to process that particular Request as there is something wrong with the Request (e.g., missing Mandatory Request parameter or Mandatory Request Payload attribute is missing, Request payload cannot be processed, etc)
- `401`: EES AIR Refuse to process that particular Request due to Authentication error. This could be caused by missing mandatory AUTH header(s), invalid Hash calculation, invalid or inactive API Key used, etc
- `403`: EES AIR Refuse to process that particular Request due to Request Authorization error(s). This indicates that used API Key has not got required permissions to perform this operation.
- `404`: EES AIR Refuse to process that particular Request as requested/referenced resource could not be found.
- `415`: EES AIR is not able to understand that request due to not supported `Content-Type` value.
- `429`: EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded.
- `500`: EES AIR refuses to process that particular Request due to Unexpected Server Error.
- `503`: EES AIR refuses to process that particular Request due to Service(s) being Unavailable (i.e. Scheduled Maintenance)
- `504`: EES AIR refuses to process that particular Request due to Networking Issues

---

[API](https://skmtc.dev/eagleeye/apis/resource-api.md) - [All operations](https://skmtc.dev/eagleeye/apis/resource-api/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeye/apis/resource-api/revisions/10217d37fdc5?raw)