EAeagleeye
Product Inventory

Get an Inventory Group (BETA)

This API endpoint allows the calling unit to retrieve a single inventory group by ID from their child unit as specified by its incomingIdentifier.

get/products/{incomingIdentifier}/groups/{groupId}

Request

  • Base URL
    https://resources.uk.eagleeye.com
  • URL
    https://resources.uk.eagleeye.com/products/{incomingIdentifier}/groups/{groupId}
  • 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.

groupIdstring string required

The unique identifier of the inventory group.

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.

idstring

The unique identifier of the inventory group.

namestring nullable

The display name of the inventory group.

typestring

The inventory group type.

descriptionstring

An optional description of the inventory group.

parentIdstring nullable

The unique identifier of this group's parent. Null for root groups.

levelinteger

The depth level of the group in the hierarchy (root is 1).

hasChildrenboolean

Whether the group has one or more child groups.

parentInventoryGroupEntity circular

Example response

{
  "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.