v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Product Inventory

Update an Inventory Product (BETA)

This API endpoint allows the calling unit to update an existing inventory product by ID for a child unit as specified by its incomingIdentifier.

put/products/{incomingIdentifier}/{productId}

Path parameters

incomingIdentifierstring string required

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

productIdstring string required

The unique identifier of the inventory product (e.g. a SKU or custom ID).

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.

Request body

idstring required

The unique identifier of the inventory product.

groupIdstring required

The identifier of the group this product belongs to.

namestring

The display name of the product.

descriptionstring nullable

An optional description of the product.

imageUrlstring nullable

URL of the product image.

supplierIdstring nullable

The identifier of the product supplier.

supplierNamestring nullable

The display name of the product supplier.

brandstring nullable

The brand of the product.

brandTypestring nullable

The brand type classification of the product.

lastSoldDatestring ees-date-time nullable

The date and time the product was last sold (ISO 8601 / ATOM format).

tagsstring[]

A list of tags associated with the product.

Example request

{
  "id": "APPLE_001",
  "groupId": "FRUIT",
  "name": "Pink Lady Apple 500g",
  "description": "Sweet, crunchy Pink Lady apples.",
  "imageUrl": "https://cdn.example.com/products/pink-lady-apple-500g.jpg",
  "supplierId": "fresh-orchard-co",
  "supplierName": "Fresh Orchard & Co.",
  "brand": "Orchard Select",
  "brandType": "own-label",
  "lastSoldDate": "2026-03-04T15:21:33+00:00",
  "tags": [
    "Fresh Produce",
    "Seasonal"
  ]
}

Response

EES AIR has successfully processed a Request.

idstring