← capabilities

Commerce Quantity-preflight

Check whether a requested product quantity is allowed for a public variant before cart or checkout. Returns known minimum, maximum, increment, stock availability and blockers from public Shopify or WooCommerce data; unknown stock remains unknown and nothing is reserved or purchased.

Forest exposes this capability as a deterministic machine-readable API for software agents. Discovery is free; execution uses the canonical paid endpoint below. The live x402 challenge is the source of truth for payment terms.

$0.003 / callPOST /commerce/quantity-preflightx402 · Base

Typical agent tasks

This capability is intended for bounded machine decisions such as:

What Forest guarantees

Boundaries

Machine contract

The request and response schemas are published in the canonical OpenAPI document. This page shows a representative input from the same production manifest.

Input example

{ "url": "https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/products/forest-demo-widget", "variant_id": "424242", "quantity": 8 }

Canonical paid endpoint

https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/commerce/quantity-preflight

OpenAPI contract →

Related capabilities