includeOutOfStock

IncludeOutOfStock is a boolean flag used in product search queries and catalog APIs to control whether items with an inventory status of out of stock are included in results. When set to true, the response may contain products that cannot be purchased immediately; when false or omitted, only in-stock items are returned.

Default behavior varies by platform, but most storefronts hide out-of-stock items to present only purchasable options. Enabling includeOutOfStock is useful for comprehensive catalogs, administrative tools, or customer scenarios where restock information or backorder options are relevant. In results, out-of-stock items are typically marked with an indicator such as “out of stock” and may include restock ETA or backorder availability.

Where it is used: includeOutOfStock appears in e-commerce platforms, product search services, and APIs that expose product inventories. It is sometimes named includeInventory, showOutOfStock, or similar, and behavior may differ across systems.

Considerations: If you include out-of-stock items, ensure stock data is current to avoid misrepresentation. This flag can affect ranking, filtering, and conversion rates, since out-of-stock items cannot be purchased immediately. Many implementations pair it with backorder or preorder statuses to provide next steps for customers. UI decisions should clearly convey availability and restock estimates.

Implementation notes: Expose includeOutOfStock as a per-request parameter and document its default. Ensure indexing includes the stock status field, and keep synchronization with the inventory system to prevent stale results.

This flag supports transparent catalog exploration and advanced workflows, but should be used with clear stock indicators and restock information to maintain user trust.