Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Units
Ingestions

Search Unit Ingestions (BETA)

This method allows the calling application to retrieve the ingestion configurations for a unit.

get/units/{unitId}/ingestions

Path parameters

unitIdstring Int64 required

EES AIR Unit ID.

Query parameters

type'PRODUCTS_AND_GROUPS' | 'OFFLINE_TRANSACTIONS' | 'MEMBERS' string

The type of ingestion to filter by.

status'ACTIVE' | 'INACTIVE' string

The status of ingestion to filter by.

offsetinteger
Example:51

Offset allows you to skip a number of items before returning data.

limitinteger

The number of items to return.

orderBystring

Requested result set sorting order

Headers

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

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

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, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

This flag denotes the number of attempts that have been made for this request.

Response

OK.

Example response

{
  "results": [
    {
      "id": "8f951748-fddc-43cf-be1d-9664d181abff",
      "type": "PRODUCTS_AND_GROUPS",
      "status": "ACTIVE",
      "config": {
        "incomingIdentifier": "unitStore"
      },
      "dateCreated": "2025-10-24T10:18:31+00:00",
      "lastUpdated": "2025-10-24T10:18:31+00:00"
    },
    {
      "id": "e4886fdf-5f3e-42d0-b868-ee3768ecb0bb",
      "type": "PRODUCTS_AND_GROUPS",
      "status": "ACTIVE",
      "config": {
        "incomingIdentifier": "unitStore"
      },
      "dateCreated": "2025-10-24T10:15:24+00:00",
      "lastUpdated": "2025-10-24T10:15:24+00:00"
    }
  ]
}