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

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

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

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

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.

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

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

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

Unique Reference for the API transaction within the calling company.

Optional header provided by the calling application for EES AIR to identify what was the external Subsystem Id / Name. Please note this header is not essential for AIR to process a Request, this header and its value will be intercepted by AIR and will show up in Wallet Event Notifications, if applicable.

Optional header(s) provided by the calling application to EES AIR. Please note a) this header name has to follow pattern X-CUSTOM-* (i.e. X-CUSTOM-EMAIL) b) this header is not essential for AIR to process a Request, this header and its value will be intercepted by AIR and will show up in Wallet Event Notifications, if applicable.