Search Inventory Groups (BETA)

get

https://resources.uk.eagleeye.com/products/{incomingIdentifier}/groups

This API endpoint allows the calling unit to search inventory groups for their child unit as specified by its incomingIdentifier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

incomingIdentifier

string

required

The incoming identifier of the unit whose inventory products and groups are being managed.

Query Params

groupId

Optional filter by one or more group IDs. Supports repeated keys (e.g. groupId=GROUP_A&groupId=GROUP_B) and URL-encoded array-style keys (e.g. groupId%5B%5D=GROUP_A&groupId%5B%5D=GROUP_B or groupId%5B0%5D=GROUP_A&groupId%5B1%5D=GROUP_B).

parentGroupId

Optional filter by one or more parent group IDs. Supports repeated keys (e.g. parentGroupId=PARENT_A&parentGroupId=PARENT_B) and URL-encoded array-style keys (e.g. parentGroupId%5B%5D=PARENT_A&parentGroupId%5B%5D=PARENT_B or parentGroupId%5B0%5D=PARENT_A&parentGroupId%5B1%5D=PARENT_B).

name

string

Optional filter by group name. Supports an exact value or a wildcard suffix using * for prefix matching. Wildcard rules: * must appear only once, must be the final character, and must have at least 3 characters before it (e.g. name=pan*).

limit

integer

1 to 100

Maximum number of groups to return (up to 100).

offset

integer

≥ 0

Number of matching groups to skip before returning results.

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