Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Product Inventory

Search the Product 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.
get/inventory

Query parameters

groupReferencestring string

EES AIR Group Reference.

incomingIdentifierstring string

EES AIR Incoming Identifier.

upcstring string

EES AIR Product UPC.

skustring string

EES AIR Product SKU.

tagstring string

EES AIR Product Tag.

namestring string

EES AIR Product Name.

supplierIdstring string

EES AIR Product Supplier ID.

supplierNamestring string

EES AIR Product Supplier Name.

brandstring string

EES AIR Product Brand.

brandTypestring string

EES AIR Product Brand Type.

lastSoldDatestring ees-date-time

EES AIR Product Last Sold Date.

matchAllboolean

Flag denoting whether all flags must match the results.

parentIncomingIdentifierstring string

EES AIR Parent Incoming Identifier.

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

Results count

Example response

{
  "results": [
    {
      "name": "EAGLE EYE TANGERINE",
      "description": "EAGLE EYE ORANGES",
      "sku": null,
      "upc": "781302048531",
      "image": "",
      "supplierId": "EE",
      "supplierName": "EAGLE EYE",
      "brand": "PURPLE CITRUS",
      "brandType": "EE VALUE",
      "lastSoldDate": "2023-16-11T08:14:24+00:00",
      "tags": [
        "ACME",
        "ADAL",
        "AIMT",
        "RDAL",
        "SACG",
        "SHGN",
        "SNCA",
        "SPRT",
        "SSEA",
        "SSPK",
        "SWMA"
      ],
      "groups": [
        {
          "reference": "84-2",
          "group-reference": "EE-84-2",
          "name": "ORANGES",
          "primary": 1
        },
        {
          "reference": "84",
          "group-reference": "EE-84",
          "name": "FRESH PRODUCE",
          "primary": 0
        }
      ]
    }
  ]
}