---
title: "Get Inventory List"
method: GET
path: "/inventoryLists/{inventoryListId}"
tags: ["Inventory List"]
---

# Get Inventory List

`GET /inventoryLists/{inventoryListId}`

## Request

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

This API endpoint allows the calling application to retrieve details for an Inventory List's products by Inventory List Id.

## Path parameters

- `inventoryListId` string, string, required

## 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
- `X-CUSTOM-SUBSYSTEM-ID` string, string
- `X-CUSTOM-KEY` string, string

## Response `200`

EES AIR has successfully processed a Request

- InventoryListEntity
  - `inventoryListId` string, string: The EES AIR ID of the Inventory List.
  - `productsLocationIdentifier` string, string: The Incoming Identifier of Unit containing the Inventory List products.
  - `type` 'EXCLUDE', string: The Type of the Inventory List.
  - `status` 'ACTIVE' | 'SUSPENDED', string: The Status of the Inventory List.
  - `name` string, string: The Name of the Inventory List.
  - `description` string, string: The Description of the Inventory List.
  - `dateCreated` string, ees-datetime: The Created Date-time (ATOM format) of the Inventory List.
  - `lastUpdated` string, ees-datetime: The Last updated Date-time (ATOM format) of the Inventory List.
  - `collections` object[]
    - `locations` object
      - `excluded` object
        - `locationIdentifiers` string[]: A list of excluded location identifiers.
        - `locationTags` string[]: A list of excluded location tags.
    - `products` object
      - `allRequired` boolean: Flag to indicated if all excluded restriction should be applied together.
      - `excluded` object
        - `groups` object, nullable: A list of excluded product groups.
          - `key1` string[]
          - `key2` string[]
        - `items` string[]: A list of excluded product items.
        - `skus` string[]: A list of excluded product SKUs.
        - `tags` string[]: A list of excluded product tags.
  - `prerequisites` object
    - `campaigns` object
      - `campaignTypes` string[]: A list of Campaign Types this Inventory List is applied to. If empty then it applies to all Campaign Types.

## 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)