AgentPay Labs · Schema

CommerceCompileRequest

CompanyResearchRoboticsAutomationPlatform

Properties

Name Type Description
need string
constitution object
limit integer
products array
View JSON Schema on GitHub

JSON Schema

agentpay-so-commerce-compile-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/agentpay-so/json-schema/agentpay-so-commerce-compile-request-schema.json",
  "title": "CommerceCompileRequest",
  "x-generated": "2026-11-01",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/agentpay-so-openapi.yml#/components/schemas/CommerceCompileRequest",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "need",
    "constitution",
    "products"
  ],
  "properties": {
    "need": {
      "type": "string",
      "maxLength": 80,
      "pattern": "^[a-zA-Z0-9]+(?:[ -][a-zA-Z0-9]+)*$"
    },
    "constitution": {
      "$ref": "#/$defs/BuyerConstitution"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20,
      "default": 5
    },
    "products": {
      "type": "array",
      "minItems": 1,
      "maxItems": 200,
      "items": {
        "$ref": "#/$defs/CommerceProductCandidate"
      }
    }
  },
  "$defs": {
    "BuyerConstitution": {
      "type": "object",
      "additionalProperties": false,
      "description": "Human-owned hard limits enforced before any model ranking.",
      "required": [
        "currency",
        "maxTotalMinor",
        "allowedCategories"
      ],
      "properties": {
        "currency": {
          "type": "string",
          "pattern": "^[A-Za-z]{3}$"
        },
        "maxTotalMinor": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100000000000
        },
        "allowedCategories": {
          "type": "array",
          "minItems": 1,
          "maxItems": 100,
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "allowedMerchants": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "blockedMerchants": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "requiresRefundable": {
          "type": "boolean",
          "default": false
        },
        "minimumReturnWindowDays": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3650
        },
        "maximumDeliveryDays": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3650
        },
        "maxEvidenceAgeMinutes": {
          "type": "integer",
          "minimum": 1,
          "maximum": 525600,
          "default": 1440
        },
        "requireHumanApproval": {
          "type": "boolean",
          "default": true
        },
        "autoApproveBelowMinor": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100000000000
        },
        "weights": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "price": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            },
            "quality": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            },
            "delivery": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            },
            "sustainability": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            }
          }
        }
      }
    },
    "CommerceProductCandidate": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "merchantId",
        "merchantName",
        "title",
        "category",
        "priceMinor",
        "currency",
        "availability",
        "checkoutUrl",
        "imageUrl",
        "deliveryDays",
        "returnWindowDays",
        "refundable",
        "catalogUpdatedAt",
        "truthScore",
        "qualityScore",
        "needSignals"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 200
        },
        "merchantId": {
          "type": "string",
          "maxLength": 200
        },
        "merchantName": {
          "type": "string",
          "maxLength": 300
        },
        "title": {
          "type": "string",
          "maxLength": 500
        },
        "category": {
          "type": "string",
          "maxLength": 120,
          "pattern": "^[a-z0-9]+(?:[-_][a-z0-9]+)*$"
        },
        "priceMinor": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100000000000
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Za-z]{3}$"
        },
        "availability": {
          "type": "string",
          "enum": [
            "in_stock",
            "out_of_stock",
            "preorder",
            "backorder"
          ]
        },
        "checkoutUrl": {
          "type": "string",
          "format": "uri",
          "pattern": "^https://"
        },
        "imageUrl": {
          "type": "string",
          "format": "uri",
          "pattern": "^https://"
        },
        "deliveryDays": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3650
        },
        "returnWindowDays": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3650
        },
        "refundable": {
          "type": "boolean"
        },
        "catalogUpdatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "truthScore": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "qualityScore": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "needSignals": {
          "type": "array",
          "minItems": 1,
          "maxItems": 30,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "need",
              "score"
            ],
            "properties": {
              "need": {
                "type": "string",
                "maxLength": 80
              },
              "score": {
                "type": "integer",
                "minimum": 0,
                "maximum": 100
              }
            }
          }
        },
        "sponsored": {
          "type": "boolean",
          "default": false
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/agentpay-so-commerce-compile-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.