v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Inventory List

Search for Inventory Lists

This API endpoint allows the calling application to retrieve all Inventory List products that includes optional criteria filtering.

get/inventoryLists

Query parameters

status'ACTIVE' | 'SUSPENDED' string

Optional Filtering criteria (e.g. status=ACTIVE) allowing the calling application to narrow down returned results by list status

type'INCLUDE' | 'EXCLUDE' string

Optional Filtering criteria (e.g. type=EXCLUDE) allow the calling application to narrow down returned results by list type

This optional request parameter allows the calling application to request a specific sorting order for a result set. Currently supported field names are: inventoryListId, type and status

offsetstring int32

This optional request parameter allows the calling application to request a specific page (pagination offset)

limitstring int32

This optional request parameter allows the calling application to influence a length of returned result-set (pagination items per page)

Headers

Accept-Encoding'''' | ''gzip'' | ''deflate'' | ''gzip,deflate'' | ''deflate,gzip'' string

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding Response header. Currently supported gzip and deflate. Please note if this request header is not present, no compression will be used.

Connection'keep-alive' | 'close' string

This general HTTP header controls (or rather influences) whether the network connection stays open after the current request finishes. If the sent value is keep-alive, the connection should stay in a special state, allowing to be reused for subsequent requests to the same server. Please note these connections will be closed after reaching timeout threshold controlled by EES server (usually after 5 seconds).

Content-Typestring string

Standard HTTP header to inform EES API what type of content was passed in request payload

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-CUSTOM-SUBSYSTEM-IDstring string

Optional header provided by the calling application for EES AIR to identify what was the external Subsystem Id / Name.

X-CUSTOM-KEYstring string

Optional header(s) provided by the calling application to EES AIR. Please note this header name has to follow pattern X-CUSTOM-*

Response

EES AIR has successfully processed a Request

offsetinteger

Result set pagination offset

limitinteger

Results per page (up to 100)

totalinteger

Results count

Example response

{
  "results": [
    {
      "inventoryListId": "1172",
      "productsLocationIdentifier": "4402",
      "status": "ACTIVE",
      "type": "EXCLUDE",
      "name": "My Inventory List",
      "description": "A description of My Inventory List",
      "dateCreated": "2022-01-02T09:54:43+00:00",
      "lastUpdated": "2022-03-09T13:20:17+00:00",
      "collections": [
        {
          "locations": {
            "excluded": {
              "locationIdentifiers": [
                "store1",
                "store2"
              ],
              "locationTags": [
                "locationTag01"
              ]
            }
          },
          "products": {
            "excluded": {
              "groups": {
                "TYPE1": [
                  "G100000001",
                  "G100000002"
                ]
              },
              "skus": [
                "P200000010",
                "P200000012"
              ],
              "tags": [
                "TAG16",
                "TAG20"
              ]
            }
          }
        }
      ],
      "prerequisites": {
        "campaigns": {
          "campaignTypes": [
            "STANDARD_NATIONAL"
          ]
        }
      }
    }
  ]
}