EAeagleeye
Product Inventory

Search Inventory Groups (BETA)

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

get/products/{incomingIdentifier}/groups

Request

  • Base URL
    https://resources.uk.eagleeye.com
  • URL
    https://resources.uk.eagleeye.com/products/{incomingIdentifier}/groups
  • Auth
    none declared. Required headers: X-EES-AUTH-CLIENT-ID, X-EES-AUTH-HASH

Path parameters

incomingIdentifierstring string required

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

Query parameters

string
OR
string[]

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

string
OR
string[]

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

namestring

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

limitinteger

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

offsetinteger

Number of matching groups to skip before returning results.

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.

Response

EES AIR has successfully processed a Request.

offsetinteger required

Result set pagination offset.

limitinteger required

Results per page (up to 100).

totalinteger required

Total number of groups matching the search.

Example response

{
  "limit": 100,
  "total": 2,
  "orderBy": [
    {
      "name": "groupId",
      "order": "ASC"
    }
  ],
  "results": [
    {
      "id": "FRUIT",
      "name": "Fruit",
      "type": "category",
      "description": "Fresh fruit",
      "parentId": "GROCERY",
      "level": 2,
      "hasChildren": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.