commercetools icon

commercetools

Interact with the commercetools API. Operations are auto-generated from the official Postman collection.

Actions671

Inventory → Query InventoryEntries

AI-generated

Summary

Query inventory entries from commercetools using optional filters to control pagination, sorting, expansion of related objects, and conditional selection.

Inputs

  • Filters — Optional parameters to filter the inventory entries returned. Includes:
  • Expand: String to expand related references in the results.
  • Sort: String to sort the results.
  • Limit: String to limit the number of results returned.
  • Offset: String to offset the starting position of results.
  • With Total: String to specify if total count should be included.
  • Where: String to apply conditional expression filters.

Output shape

A single JSON object representing the API response from commercetools containing the queried inventory entries, including pagination and expansion as specified.

The output shape is governed by commercetools API response format for inventory queries. Supports pagination through limit and offset parameters and may include related resources if 'expand' is used. Errors during the request raise NodeApiError unless continueOnFail is enabled.

Examples

Example 1: Retrieve first 10 inventory entries sorted by quantity

Set Filters with Limit='10' and Sort='quantity desc'.

Example 2: Query inventory entries with product variants expanded

Set Filters with Expand='productVariant' to include expanded product variant details.

Links

Discussion