Search the Product Inventory

get

https://resources.uk.eagleeye.com/inventory

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

groupReference

string

EES AIR Group Reference.

incomingIdentifier

string

EES AIR Incoming Identifier.

upc

string

EES AIR Product UPC.

sku

string

EES AIR Product SKU.

tag

string

EES AIR Product Tag.

name

string

EES AIR Product Name.

supplierId

string

EES AIR Product Supplier ID.

supplierName

string

EES AIR Product Supplier Name.

brand

string

EES AIR Product Brand.

brandType

string

EES AIR Product Brand Type.

lastSoldDate

string

EES AIR Product Last Sold Date.

matchAll

boolean

Defaults to false

Flag denoting whether all flags must match the results.

parentIncomingIdentifier

string

EES AIR Parent Incoming Identifier.

Headers

Accept-Encoding

string

enum

Defaults to ''

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.

Allowed:

Connection

string

enum

Defaults to close

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

Allowed:

X-EES-AUTH-CLIENT-ID

string

required

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

X-EES-AUTH-HASH

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

string

Unique Reference for the API transaction within the calling company.

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

200EES AIR has successfully processed a Request

400EES 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)

401EES 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

403EES 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.

404EES AIR Refuse to process that particular Request as requested/referenced resource could not be found.

415EES AIR is not able to understand that request due to not supported Content-Type value.

429EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded.

500EES AIR refuses to process that particular Request due to Unexpected Server Error.

503EES AIR refuses to process that particular Request due to Service(s) being Unavailable (i.e. Scheduled Maintenance)

504EES AIR refuses to process that particular Request due to Networking Issues