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

# Replace Inventory List

`PUT /inventoryLists/{inventoryListId}`

This API endpoint allows the calling application to update an existing Inventory List.

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

## Request body

- object
  - `inventoryListId` string, string — The EES AIR ID of the Inventory List.
  - `productsLocationIdentifier` string, string, required — The Incoming Identifier of Unit containing the Inventory List products.
  - `type` 'EXCLUDE', string, required — The Type of the Inventory List.
  - `status` 'ACTIVE' | 'SUSPENDED', string, required — The Status of the Inventory List.
  - `name` string, string, required — The Name of the Inventory List.
  - `description` string, string — The Description of the Inventory List.
  - `dateCreated` string, ees-datetime, required — The Created Date-time (ATOM format) of the Inventory List.
  - `lastUpdated` string, ees-datetime, required — The Last updated Date-time (ATOM format) of the Inventory List.
  - `collections` object[], required
    - `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, required
    - `campaigns` object
      - `campaignTypes` string[] — A list of Campaign Types this Inventory List is applied to. If empty then it applies to all Campaign Types.

## Response `200`

EES AIR has successfully processed a Request.

- object
  - `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. Request Payload is unprocessable, Mandatory Request Parameter value is not provided, etc.)
- `401` — EES AIR refuse to process that particular Request due to Authentication error(s). This could be caused by missing one or more of mandatory AUTH headers, invalid Hash calculation, invalid or inactive API Key used, etc.
- `403` — EES AIR refuse to process that particular Request due to Authorisation error(s). Please note nothing is wrong with Authentication nor hash Calculation, it is simply due to lack of permission to perform that particular action (e.g. Issuance Partner attempts to Redeem a Token or Redemption Partner attempts to Issue a Token, etc.)
- `404` — EES AIR refuse to process that particular Request as requested Resource could not be found or referenced Resource is not active.
- `415` — EES AIR refuse to process that particular Request as requested `Mime-Type` is not supported (Currently only `application/json` is supported
- `429` — EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded.
- `500` — EES AIR is not able 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.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/revisions/90a122bb14cc/schema)