Api Endpoint

Forest Commerce

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. Base mainnet USDC

Open interactive test console

Offering

Provider
http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run
Method
POST
Offering type
Api Endpoint
Transport type
http
Category
Business And Commerce
Delivery
Not provided
Pricing model
Not provided
x402 version
2

Endpoint context

URL
https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/commerce/quantity-preflight
MIME type
Not provided
First seen
2026-10-16T01:50:45.949Z
Last seen
Tags
commerce, quantity, order-limit, stock, cart

Payment pricing

x402 payment terms are the authoritative price for calling this endpoint.

Payment option 1
0.003 USDC
Atomic price: 3000 · Network: eip155:8453 · Asset: USDC · Scheme: exact
Raw x402 terms
[
  {
    "scheme": "exact",
    "network": "eip155:8453",
    "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
    "amount": "3000",
    "payTo": "0xb48D918151311F982d542eF5C84cc1cd54CFf7a9"
  }
]

Observed health

Status
Reachable
Latest latency
260 ms
Average latency
811 ms
HTTP status
405
Last checked
Reachability
100% over 14 checks

Latency is measured to the first response headers. A reachable result does not verify response accuracy or merchant identity.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "body": {
      "additionalProperties": false,
      "properties": {
        "destination": {
          "additionalProperties": true,
          "description": "Public identifiers value used to scope this lookup.",
          "type": "object"
        },
        "options": {
          "additionalProperties": true,
          "description": "Public identifiers value used to scope this lookup.",
          "type": "object"
        },
        "previous_hash": {
          "description": "Earlier result hash used to detect a material change.",
          "pattern": "^sha256:[a-f0-9]{64}$",
          "type": "string"
        },
        "quantity": {
          "description": "Requested item quantity to validate against provider limits.",
          "maximum": 100,
          "minimum": 1,
          "type": "integer"
        },
        "url": {
          "description": "Public HTTP(S) URL to inspect, resolve, or compare.",
          "maxLength": 2048,
          "pattern": "^https?://",
          "type": "string"
        },
        "variant": {
          "additionalProperties": true,
          "description": "Public identifiers value used to scope this lookup.",
          "type": "object"
        },
        "variant_id": {
          "description": "Public provider variant identifier to validate.",
          "maxLength": 256,
          "type": "string"
        }
      },
      "required": [
        "url",
        "variant_id",
        "quantity"
      ],
      "type": "object"
    },
    "bodyType": {
      "enum": [
        "json",
        "form-data",
        "text"
      ],
      "type": "string"
    },
    "method": {
      "enum": [
        "POST"
      ],
      "type": "string"
    },
    "type": {
      "const": "http",
      "type": "string"
    }
  },
  "required": [
    "type",
    "method",
    "bodyType",
    "body"
  ],
  "type": "object"
}

Output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "input": {
      "additionalProperties": false,
      "properties": {
        "body": {
          "additionalProperties": false,
          "properties": {
            "destination": {
              "additionalProperties": true,
              "description": "Public identifiers value used to scope this lookup.",
              "type": "object"
            },
            "options": {
              "additionalProperties": true,
              "description": "Public identifiers value used to scope this lookup.",
              "type": "object"
            },
            "previous_hash": {
              "description": "Earlier result hash used to detect a material change.",
              "pattern": "^sha256:[a-f0-9]{64}$",
              "type": "string"
            },
            "quantity": {
              "description": "Requested item quantity to validate against provider limits.",
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            },
            "url": {
              "description": "Public HTTP(S) URL to inspect, resolve, or compare.",
              "maxLength": 2048,
              "pattern": "^https?://",
              "type": "string"
            },
            "variant": {
              "additionalProperties": true,
              "description": "Public identifiers value used to scope this lookup.",
              "type": "object"
            },
            "variant_id": {
              "description": "Public provider variant identifier to validate.",
              "maxLength": 256,
              "type": "string"
            }
          },
          "required": [
            "url",
            "variant_id",
            "quantity"
          ],
          "type": "object"
        },
        "bodyType": {
          "enum": [
            "json",
            "form-data",
            "text"
          ],
          "type": "string"
        },
        "method": {
          "enum": [
            "POST"
          ],
          "type": "string"
        },
        "type": {
          "const": "http",
          "type": "string"
        }
      },
      "required": [
        "type",
        "method",
        "bodyType",
        "body"
      ],
      "type": "object"
    },
    "output": {
      "properties": {
        "example": {
          "additionalProperties": false,
          "properties": {
            "capability": {
              "const": "commerce.quantity-preflight",
              "description": "Public capability value used to scope this lookup."
            },
            "data": {
              "additionalProperties": false,
              "description": "Public data value used to scope this lookup.",
              "properties": {
                "allowed": {
                  "description": "Public allowed value used to scope this lookup.",
                  "type": "boolean"
                },
                "available_quantity": {
                  "description": "Public available quantity value used to scope this lookup.",
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "blockers": {
                  "description": "Public blockers value used to scope this lookup.",
                  "type": "array"
                },
                "increment": {
                  "description": "Public increment value used to scope this lookup.",
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "max": {
                  "description": "Public max value used to scope this lookup.",
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "min": {
                  "description": "Public min value used to scope this lookup.",
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "requested_quantity": {
                  "description": "Public requested quantity value used to scope this lookup.",
                  "type": "integer"
                },
                "stock_known": {
                  "description": "Public stock known value used to scope this lookup.",
                  "type": "boolean"
                }
              },
              "required": [
                "allowed",
                "requested_quantity",
                "min",
                "max",
                "increment",
                "stock_known",
                "available_quantity",
                "blockers"
              ],
              "type": "object"
            },
            "meta": {
              "additionalProperties": false,
              "description": "Public meta value used to scope this lookup.",
              "properties": {
                "cache": {
                  "description": "Public cache value used to scope this lookup.",
                  "enum": [
                    "hit",
                    "miss",
                    "bypass"
                  ]
                },
                "checked_at": {
                  "description": "Public checked at value used to scope this lookup.",
                  "type": "string"
                },
                "duration_ms": {
                  "description": "Public duration ms value used to scope this lookup.",
                  "minimum": 0,
                  "type": "integer"
                },
                "provider": {
                  "description": "Public provider value used to scope this lookup.",
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "provider",
                "checked_at",
                "cache",
                "duration_ms"
              ],
              "type": "object"
            },
            "ok": {
              "const": true,
              "description": "Public ok value used to scope this lookup."
            },
            "version": {
              "const": "1",
              "description": "Package version whose public metadata should be checked."
            }
          },
          "required": [
            "ok",
            "capability",
            "version",
            "data",
            "meta"
          ],
          "type": "object"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "input"
  ],
  "type": "object"
}