ReferenceApi
Quote an OpenPermit-compatible storefront order
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
storefrontUrl*string
mandateId*string
items*array<>
idempotencyKey*string
metadata?
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/agent/commerce/quote" \ -H "Content-Type: application/json" \ -d '{ "storefrontUrl": "http://example.com", "mandateId": "string", "items": [ {} ], "idempotencyKey": "string" }'{ "status": "quoted", "storefront": { "name": "string", "seller": { "sellerId": "string", "name": "string", "domain": "string", "verified": false, "minimumAssuranceLevel": "softwareApproved" }, "sellerId": "string", "resourceId": "string", "catalogUrl": "http://example.com", "quoteUrl": "http://example.com", "checkoutUrl": "http://example.com", "supportedPaymentChallengeTypes": [ "x402" ], "chain": "string", "asset": "string", "paymentScope": { "paymentMode": "openpermit7702", "payTo": "string", "tokenAddress": "string", "tokenDecimals": 0, "tokenName": "string", "tokenVersion": "string", "facilitatorAddresses": [ "string" ] }, "agentInstructions": "string", "actions": {}, "metadata": {} }, "quote": { "quoteId": "string", "sellerId": "string", "resourceId": "string", "amount": "string", "asset": "string", "items": [ { "productId": "string", "variantId": "string", "name": "string", "color": "string", "size": "string", "quantity": 1, "unitAmount": "string", "totalAmount": "string", "asset": "string", "metadata": {} } ], "expiresAt": "string", "metadata": {} }, "mandateId": "string", "policyCheck": "deferredUntilPlaceOrder"}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }, "errors": [ { "detail": "string", "pointer": "string" } ]}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}