PhotoPrintAgent commercial MCP
PhotoPrintAgent commercial API. Sandbox tests do not request production access. Agents prepare a private application draft, then request its applicant review email. Hosted applicant confirmation and settled refundable deposit precede administrator review. Draft status returns the durable receipt. Production keys require administrator approval and verified-account OAuth. Commercial ordering uses scoped keys, configured quotas and prepaid credit. Guide: https://photoprintagent.com/docs/mcp-commercial.
Start here
Test in sandbox · Apply for production access
Endpoint: https://photoprintagent.com/mcp-commercial. The full /mcp and narrow /mcp-narrow consumer connectors remain unchanged. /mcp/sandbox is isolated and never charges or fulfills.
Prepare, confirm, pay and recover
- Discover with
get_sandbox_options; connect to/mcp/sandbox, callstart_sandboxwithout Authorization, and save its returned token privately. Complete and verify a simulated checkout. For sandbox-only requests, stop and report that no production application was submitted. - For production onboarding, call
prepare_production_applicationon the commercial endpoint without an applicant account. Register your OAuth client using the public registration service if needed. Provide itsclientId, complete business details, optionalreviewEmailfor an authorized reviewer other than the business contact, requested scopes, completed sandbox order ID and temporary token. Generate and retain a private randomreviewNonce(64 hexadecimal characters) and stableidempotencyKeyfor recovery. Never put secrets in URLs or chat. Save returneddraftIdanddraftTokensecurely. Sandbox evidence is validated and retained for 90 days; its original token is never saved or shown in the review. - Call
request_production_application_reviewwithdraftId,draftToken, currentversionand a stable emailidempotencyKey. PhotoPrintAgent emails only the selected reviewer, using the business contact when no separate reviewer was specified. The person who confirms is recorded as the application owner. The agent does not receive the review link. The applicant opens it to review all fields, sandbox evidence and exact attestations. Opening alone does not verify an account or submit. - The applicant explicitly selects Confirm and submit application and accepts the displayed attestations. The page shows Application Pending with the saved details; the applicant then chooses and authorizes the separate Pay refundable deposit step at the displayed amount in an embedded on-site payment modal. No administrator application exists until payment is verified. The credit is held during review, becomes account credit on approval and is refunded if rejected. Automatic refill is off by default and requires separate explicit authorization.
- Call
get_production_application_draftwith your private draft capability. Report an application only whenapplicationReceivedis true and anapplicationIdis returned. ReportapplicationStatus: pendingas Awaiting review. Confirmation/payment retries recover the same application ID. If payment is uncertain, recover the saved checkout; never submit a second payment. Missed payment confirmation is reconciled server-side. - Corrections use
update_production_application_draftwith the current version and complete editable fields, or justfields.reviewEmailto change the recipient. Set it to null to use the contact email again. Then request a fresh review email. Old links cannot submit changed versions. Expired links can be reissued for the same current version without a new sandbox credential while evidence remains valid. Payment preparation locks the reviewed version; contact support rather than change a funded application. - Administrator review appears at
/admin/api-accesswith notifications to info@photoprintagent.com and support@photoprintagent.com. Only an authorized administrator can approve. Production credentials are never issued by confirmation or payment. - After approval, connect the applicant’s verified account using OAuth resource
https://photoprintagent.com/mcp-commercial, scopesmcp:read mcp:write, and the same registered clientId. Callget_production_access_application, thenissue_production_keywith its current keyVersion. Store the secret privately. After a lost key response read status and deliberately rotate; do not blindly retry. Production keys expire after 90 days.
Resend a review email
Use resend_production_application_review with draftId, draftToken, current version, and a new idempotencyKey for an intentional resend. Retry the same key after a lost response to avoid another send. The new link supersedes old links; the recipient and application details do not change. Wait at least one minute between sends. If delivery is queued, retrying or sending, read status and wait. If delivery is uncertain, obtain authorization for a possible duplicate and pass acknowledgePossibleDuplicate: true. For a changed recipient, first update reviewEmail using update_production_application_draft, then call request_production_application_review for the new version. Never create another draft to resend email.
Accurate completion reports
- Sandbox only: Simulation verified. No production application was submitted.
- Draft or review email: Draft saved; awaiting applicant confirmation and refundable deposit. No production application submitted.
- Confirmed but unpaid: Application Pending; details saved and refundable deposit required. No application in administrator review.
- Verified receipt: Application [returned applicationId] received; awaiting review when its recorded status is pending.
- Blocked: report the exact missing field, expired evidence, email delivery state, confirmation or payment step. If a request timed out, say Receipt unverified and recover the same capability/idempotency key. Never infer receipt from sandbox success, email delivery or an OAuth connection.
Commercial ordering and support
Approved prepaid integrations use their configured print and shipping pricing and available balance. Shipping and tax are itemized; private costs are never exposed. Administrators configure quotas and pricing individually. Existing paid orders remain recoverable during quota pauses. Use get_commercial_balance, get_commercial_transactions, lookup_order, get_order_events and replay_order_events. The full integration guide defines order statuses, safe retries and webhook recovery. Legacy applications remain recoverable; request_production_access does not bypass the new review and funding requirements.
Tool contract
get_sandbox_options
Public: discover self-service sandbox provisioning, its separate MCP endpoint, exact glossy 4x6 fixture and runnable simulated-order walkthrough. Sandbox orders cannot charge or enter fulfillment.
{
"name": "get_sandbox_options",
"title": "Get Sandbox Options",
"description": "Public: discover self-service sandbox provisioning, its separate MCP endpoint, exact glossy 4x6 fixture and runnable simulated-order walkthrough. Sandbox orders cannot charge or enter fulfillment.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"environment": {
"type": "string",
"const": "sandbox"
},
"chargesEnabled": {
"type": "boolean",
"const": false
},
"fulfillmentEnabled": {
"type": "boolean",
"const": false
},
"endpoint": {
"type": "string",
"format": "uri"
},
"documentation": {
"type": "string",
"format": "uri"
},
"authentication": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"product": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"environment",
"chargesEnabled",
"fulfillmentEnabled",
"endpoint",
"documentation",
"authentication",
"product"
],
"additionalProperties": {}
}
}
get_checkout_preferences
Read this connection or guest session’s saved Express Order sharing choice before collecting delivery details. Returns consent only, never contact details. If enabled, use only home address, email and phone already available in ChatGPT for the requested order; ask for missing or ambiguous details. Client privacy controls and final order/payment approval still apply.
{
"name": "get_checkout_preferences",
"title": "Get Checkout Preferences",
"description": "Read this connection or guest session’s saved Express Order sharing choice before collecting delivery details. Returns consent only, never contact details. If enabled, use only home address, email and phone already available in ChatGPT for the requested order; ask for missing or ambiguous details. Client privacy controls and final order/payment approval still apply.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"expressOrder": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"homeAddress",
"email",
"phone"
]
}
},
"source": {
"type": "string",
"const": "chatgpt_available_context"
},
"purpose": {
"type": "string",
"const": "prepare_print_orders"
},
"requiresOrderApproval": {
"type": "boolean",
"const": true
},
"permissionNotice": {
"type": "string"
}
},
"required": [
"enabled",
"fields",
"source",
"purpose",
"requiresOrderApproval",
"permissionNotice"
],
"additionalProperties": false
},
"setupTermsAccepted": {
"type": "boolean"
}
},
"required": [
"expressOrder",
"setupTermsAccepted"
],
"additionalProperties": false
}
}
list_products
Browse available products, 4x6 first. Use returned products[].id for uploads and quotes. Filter by size, finish, category, price or query. Follow nextOffset; includeDetails:true adds artwork, shipping and fit specifications. availableOnly:false also includes unavailable public listings. Prices exclude shipping/tax; quote_prints returns a payable total.
{
"name": "list_products",
"title": "List Products",
"description": "Browse available products, 4x6 first. Use returned products[].id for uploads and quotes. Filter by size, finish, category, price or query. Follow nextOffset; includeDetails:true adds artwork, shipping and fit specifications. availableOnly:false also includes unavailable public listings. Prices exclude shipping/tax; quote_prints returns a payable total.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"query": {
"type": "string",
"maxLength": 100
},
"category": {
"type": "string",
"maxLength": 80
},
"finish": {
"type": "string",
"maxLength": 80
},
"widthInches": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000
},
"heightInches": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000
},
"minPriceCents": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"maxPriceCents": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"includeDetails": {
"default": false,
"type": "boolean"
},
"availableOnly": {
"default": true,
"type": "boolean"
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"default": 12,
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"product": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"productCode": {
"type": "string"
},
"title": {
"type": "string"
},
"specs": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"id",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"productCode": {
"type": "string",
"pattern": "^PPA[A-F0-9]{12}$"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"unitPriceCents": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
{
"type": "null"
}
]
},
"category": {
"type": "string"
},
"finish": {
"type": "string"
},
"size": {
"type": "string"
},
"widthInches": {
"type": "number"
},
"heightInches": {
"type": "number"
},
"artwork": {
"type": "object",
"properties": {
"qualityGuidance": {
"type": "object",
"properties": {
"recommendedDpi": {
"type": "number"
},
"minimumDpiIsRejectionThreshold": {
"type": "boolean"
},
"fitModes": {
"type": "array",
"items": {
"type": "string"
}
},
"fitDescription": {
"type": "string"
}
},
"required": [
"recommendedDpi",
"minimumDpiIsRejectionThreshold",
"fitModes",
"fitDescription"
],
"additionalProperties": false
},
"widthPixels": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"heightPixels": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"minImages": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxImages": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"minimumDpi": {
"type": "number"
},
"allowRotate": {
"type": "boolean"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"bleed": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"issues": {
"type": "array",
"items": {
"type": "string"
}
},
"calendar": {
"type": "object",
"properties": {
"layout": {
"type": "string",
"const": "alternating-photo-grid"
},
"months": {
"anyOf": [
{
"type": "number",
"const": 12
},
{
"type": "number",
"const": 18
}
]
}
},
"required": [
"layout",
"months"
],
"additionalProperties": false
},
"composition": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"background": {
"type": "string"
},
"slots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"y": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"width",
"height",
"background",
"slots"
],
"additionalProperties": false
}
},
"required": [
"widthPixels",
"heightPixels",
"minImages",
"maxImages",
"minimumDpi",
"allowRotate",
"labels",
"bleed",
"issues"
],
"additionalProperties": false
},
"shipping": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"provider",
"flat",
"per_item"
]
},
"amountCents": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"multipleItemAmountCents": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100000
},
{
"type": "null"
}
]
}
},
"required": [
"mode",
"amountCents",
"multipleItemAmountCents"
],
"additionalProperties": false
},
"adminOnly": {
"type": "boolean"
},
"available": {
"type": "boolean"
},
"unavailableReason": {
"type": "string"
},
"preview": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"workflow": {
"type": "string"
}
},
"required": [
"id",
"title",
"widthInches",
"heightInches"
],
"additionalProperties": {}
}
},
"orderingAvailable": {
"type": "boolean"
},
"total": {
"type": "number"
},
"nextOffset": {
"type": [
"number",
"null"
]
},
"deliveryEstimate": {
"type": "string"
},
"capabilities": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"supported": {
"type": "boolean"
},
"availableToOrder": {
"type": "boolean"
},
"productCount": {
"type": "number"
}
},
"required": [
"supported",
"availableToOrder",
"productCount"
],
"additionalProperties": false
}
},
"priceFilterBasis": {
"type": "string"
}
},
"required": [
"product",
"products",
"orderingAvailable",
"total",
"nextOffset",
"capabilities",
"priceFilterBasis"
],
"additionalProperties": false
}
}
get_upload_status
Recover a private image upload by its original idempotencyKey. Returns its photo ID when complete, without downloading or uploading again. Processing means wait; retryable means repeat the original upload.
{
"name": "get_upload_status",
"title": "Get Upload Status",
"description": "Recover a private image upload by its original idempotencyKey. Returns its photo ID when complete, without downloading or uploading again. Processing means wait; retryable means repeat the original upload.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"idempotencyKey": {
"type": "string",
"pattern": "^[\\w-]{16,100}$"
}
},
"required": [
"idempotencyKey"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"complete",
"processing",
"retryable"
]
},
"photo": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"productId": {
"type": "string"
},
"artworkKey": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"quality": {
"type": "string",
"enum": [
"high",
"reduced"
]
},
"sourceFormat": {
"type": "string"
},
"sourceImages": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"expiresAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"width",
"height",
"quality",
"expiresAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"photo"
],
"additionalProperties": false
}
}
import_photo
Import an attached or generated ChatGPT image directly into your private print photos. Use the file supplied by ChatGPT, a catalog productId, crop options and a stable idempotencyKey. Returns the photo ID for preview and quoting. Retrying identical image bytes/options with the same key is safe. No website upload is needed.
{
"name": "import_photo",
"title": "Import Photo",
"description": "Import an attached or generated ChatGPT image directly into your private print photos. Use the file supplied by ChatGPT, a catalog productId, crop options and a stable idempotencyKey. Returns the photo ID for preview and quoting. Retrying identical image bytes/options with the same key is safe. No website upload is needed.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"file": {
"type": "object",
"properties": {
"download_url": {
"type": "string",
"maxLength": 8192,
"format": "uri"
},
"file_id": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"mime_type": {
"type": "string",
"maxLength": 150
},
"file_name": {
"type": "string",
"maxLength": 500
}
},
"required": [
"download_url",
"file_id"
],
"additionalProperties": false
},
"productId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,63}$"
},
"crop": {
"type": "object",
"properties": {
"fit": {
"default": "cover",
"type": "string",
"enum": [
"cover",
"contain"
]
},
"orientation": {
"default": "landscape",
"type": "string",
"enum": [
"landscape",
"portrait"
]
},
"rotation": {
"description": "Clockwise image rotation after EXIF orientation, before cropping. Inspect the image and correct clearly sideways or upside-down content automatically; preserve intentional orientation. Choose portrait/landscape separately to match the corrected image.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 90
},
{
"type": "number",
"const": 180
},
{
"type": "number",
"const": 270
}
]
},
"x": {
"default": 50,
"type": "number",
"minimum": 0,
"maximum": 100
},
"y": {
"default": 50,
"type": "number",
"minimum": 0,
"maximum": 100
}
},
"additionalProperties": false
},
"idempotencyKey": {
"type": "string",
"pattern": "^[\\w-]{16,100}$"
}
},
"required": [
"file",
"idempotencyKey"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"productId": {
"type": "string"
},
"artworkKey": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"quality": {
"type": "string",
"enum": [
"high",
"reduced"
]
},
"sourceFormat": {
"type": "string"
},
"sourceImages": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"expiresAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"width",
"height",
"quality",
"expiresAt"
],
"additionalProperties": false
}
}
create_upload
Prepare a private binary upload. Supply productId from list_products; POST image bytes separately to uploadUrl with the returned headers and credential. No storage is allocated until POST. Reuse an Idempotency-Key for identical bytes/options; GET /api/uploads/{key} recovers a lost response. No base64 or remote image URLs in MCP. Read returned image limits. SDK: /sdk/photo-upload.mjs.
{
"name": "create_upload",
"title": "Create Upload",
"description": "Prepare a private binary upload. Supply productId from list_products; POST image bytes separately to uploadUrl with the returned headers and credential. No storage is allocated until POST. Reuse an Idempotency-Key for identical bytes/options; GET /api/uploads/{key} recovers a lost response. No base64 or remote image URLs in MCP. Read returned image limits. SDK: /sdk/photo-upload.mjs.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,63}$"
},
"crop": {
"type": "object",
"properties": {
"fit": {
"default": "cover",
"type": "string",
"enum": [
"cover",
"contain"
]
},
"orientation": {
"default": "landscape",
"type": "string",
"enum": [
"landscape",
"portrait"
]
},
"rotation": {
"description": "Clockwise image rotation after EXIF orientation, before cropping. Inspect the image and correct clearly sideways or upside-down content automatically; preserve intentional orientation. Choose portrait/landscape separately to match the corrected image.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 90
},
{
"type": "number",
"const": 180
},
{
"type": "number",
"const": 270
}
]
},
"x": {
"default": 50,
"type": "number",
"minimum": 0,
"maximum": 100
},
"y": {
"default": 50,
"type": "number",
"minimum": 0,
"maximum": 100
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"uploadUrl": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "POST"
},
"authorization": {
"type": "string",
"const": "Bearer: use your existing account or guest credential"
},
"headers": {
"type": "object",
"properties": {
"X-Photo-Options": {
"type": "string"
},
"X-Product-Id": {
"type": "string"
}
},
"required": [
"X-Photo-Options"
],
"additionalProperties": false
},
"acceptedMimeTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"acceptedExtensions": {
"type": "array",
"items": {
"type": "string"
}
},
"imageHandling": {
"type": "object",
"properties": {
"resolutionPolicy": {
"type": "string"
},
"animationPolicy": {
"type": "string"
},
"multipagePolicy": {
"type": "string"
},
"transparencyPolicy": {
"type": "string"
},
"colorPolicy": {
"type": "string"
},
"svgPolicy": {
"type": "string"
},
"unsupportedPolicy": {
"type": "string"
},
"helpUrl": {
"type": "string"
}
},
"required": [
"resolutionPolicy",
"animationPolicy",
"multipagePolicy",
"transparencyPolicy",
"colorPolicy",
"svgPolicy",
"unsupportedPolicy",
"helpUrl"
],
"additionalProperties": false
},
"maxFileBytes": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxInputPixels": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"helpUrl": {
"type": "string",
"format": "uri"
},
"responseSchemaUrl": {
"type": "string",
"format": "uri"
},
"artwork": {
"type": "object",
"properties": {
"qualityGuidance": {
"type": "object",
"properties": {
"recommendedDpi": {
"type": "number"
},
"minimumDpiIsRejectionThreshold": {
"type": "boolean"
},
"fitModes": {
"type": "array",
"items": {
"type": "string"
}
},
"fitDescription": {
"type": "string"
}
},
"required": [
"recommendedDpi",
"minimumDpiIsRejectionThreshold",
"fitModes",
"fitDescription"
],
"additionalProperties": false
},
"widthPixels": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"heightPixels": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"minImages": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxImages": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"minimumDpi": {
"type": "number"
},
"allowRotate": {
"type": "boolean"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"bleed": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"issues": {
"type": "array",
"items": {
"type": "string"
}
},
"calendar": {
"type": "object",
"properties": {
"layout": {
"type": "string",
"const": "alternating-photo-grid"
},
"months": {
"anyOf": [
{
"type": "number",
"const": 12
},
{
"type": "number",
"const": 18
}
]
}
},
"required": [
"layout",
"months"
],
"additionalProperties": false
},
"composition": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"background": {
"type": "string"
},
"slots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"y": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"x",
"y",
"width",
"height"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"width",
"height",
"background",
"slots"
],
"additionalProperties": false
}
},
"required": [
"widthPixels",
"heightPixels",
"minImages",
"maxImages",
"minimumDpi",
"allowRotate",
"labels",
"bleed",
"issues"
],
"additionalProperties": false
}
},
"required": [
"uploadUrl",
"method",
"authorization",
"headers",
"acceptedMimeTypes",
"acceptedExtensions",
"imageHandling",
"maxFileBytes",
"maxInputPixels",
"helpUrl",
"responseSchemaUrl"
],
"additionalProperties": false
}
}
quote_prints
Save a quote for owned photos and a US address with buyer consent. Use productId from list_products. Single-image items use photoId; multi-image items use ordered photoIds. For calendars include startYear/startMonth and upload cover/month photos only; the service generates grids. For compositions upload separate slot images. Quantity counts complete products. Returned totals include shipping, tax and any validated coupon.
{
"name": "quote_prints",
"title": "Quote Prints",
"description": "Save a quote for owned photos and a US address with buyer consent. Use productId from list_products. Single-image items use photoId; multi-image items use ordered photoIds. For calendars include startYear/startMonth and upload cover/month photos only; the service generates grids. For compositions upload separate slot images. Quantity counts complete products. Returned totals include shipping, tax and any validated coupon.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,63}$"
},
"items": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"calendar": {
"type": "object",
"properties": {
"startYear": {
"type": "integer",
"minimum": 2000,
"maximum": 2100
},
"startMonth": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"required": [
"startYear",
"startMonth"
],
"additionalProperties": false
},
"productId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,63}$"
},
"photoId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"photoIds": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 99
}
},
"required": [
"quantity"
],
"additionalProperties": false
}
},
"shipping": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"phone": {
"type": "string"
},
"line1": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"line2": {
"default": "",
"type": "string",
"maxLength": 150
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"state": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"zip": {
"type": "string",
"pattern": "^\\d{5}(-\\d{4})?$"
},
"country": {
"type": "string",
"const": "US"
}
},
"required": [
"firstName",
"lastName",
"email",
"phone",
"line1",
"city",
"state",
"zip",
"country"
],
"additionalProperties": false
},
"consent": {
"type": "boolean",
"const": true
},
"couponCode": {
"type": "string",
"maxLength": 64
},
"campaignId": {
"type": "string",
"pattern": "^[a-f0-9]{16}$"
}
},
"required": [
"items",
"shipping",
"consent"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"expiresAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"photoId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"photoIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"productId": {
"type": "string"
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"calendar": {
"type": "object",
"properties": {
"startYear": {
"type": "integer",
"minimum": 2000,
"maximum": 2100
},
"startMonth": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"required": [
"startYear",
"startMonth"
],
"additionalProperties": false
}
},
"required": [
"productId",
"quantity"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"price",
"validUntil",
"expiresAt",
"lineItems"
],
"additionalProperties": false
}
}
create_print_order
Create one buyer-approved order from a saved quote. Requires explicit termsAccepted and buyerApproved. Save orderReference and idempotencyKey first; retry identical input with the same key, or recover with lookup_order. Returns private on-site checkout. Zero-total orders submit without payment. Coupon must match the approved quote. Prepaid commercial accounts use method prepaid, reserving their approved total exactly once from available credit.
{
"name": "create_print_order",
"title": "Create Print Order",
"description": "Create one buyer-approved order from a saved quote. Requires explicit termsAccepted and buyerApproved. Save orderReference and idempotencyKey first; retry identical input with the same key, or recover with lookup_order. Returns private on-site checkout. Zero-total orders submit without payment. Coupon must match the approved quote. Prepaid commercial accounts use method prepaid, reserving their approved total exactly once from available credit.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"quoteId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"couponCode": {
"type": "string",
"maxLength": 64
},
"idempotencyKey": {
"type": "string",
"pattern": "^[-\\w]{16,100}$"
},
"orderReference": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
"buyerApproved": {
"type": "boolean",
"const": true
},
"termsAccepted": {
"type": "boolean",
"const": true,
"description": "Required explicit acceptance of https://photoprintagent.com/terms for this order, with buyer authorization. Missing or false acceptance is rejected."
},
"method": {
"default": "prepaid",
"type": "string",
"enum": [
"prepaid",
"card",
"x402"
]
}
},
"required": [
"quoteId",
"idempotencyKey",
"buyerApproved",
"termsAccepted"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"order": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"orderReference": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"creating_checkout",
"awaiting_payment",
"verifying_payment",
"settling_payment",
"paid",
"submitting",
"processing",
"needs_review",
"expired"
]
},
"method": {
"type": "string",
"enum": [
"card",
"x402",
"prepaid"
]
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"pricingVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"paymentDeadline": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"canEditCoupon": {
"type": "boolean"
},
"canRenewCheckout": {
"type": "boolean"
},
"cardPaymentUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cardProcessor": {
"anyOf": [
{
"type": "string",
"enum": [
"square",
"stripe"
]
},
{
"type": "null"
}
]
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"progress": {
"type": "object",
"properties": {
"productionStatus": {
"type": "string",
"enum": [
"not_submitted",
"queued",
"submitting",
"accepted",
"printing",
"shipped",
"delivered",
"cancelled",
"on_hold",
"needs_review",
"unknown"
]
},
"shipmentStatus": {
"type": "string",
"enum": [
"unknown",
"shipped",
"delivered"
]
},
"lastUpdatedAt": {
"type": [
"number",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"supportStatus": {
"type": "string",
"enum": [
"none",
"open",
"waiting_customer",
"under_review",
"resolved"
]
},
"canRequestCancellation": {
"type": "boolean"
},
"canRequestChange": {
"type": "boolean"
},
"canRequestRefund": {
"type": "boolean"
},
"cancellationGuaranteed": {
"type": "boolean",
"const": false
}
},
"required": [
"productionStatus",
"shipmentStatus",
"lastUpdatedAt",
"trackingUrls",
"supportStatus",
"canRequestCancellation",
"canRequestChange",
"canRequestRefund",
"cancellationGuaranteed"
],
"additionalProperties": false
},
"productName": {
"type": "string"
},
"imageCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"paidAt": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
{
"type": "null"
}
]
},
"paymentStatus": {
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
},
"fulfillmentStatus": {
"type": "string",
"enum": [
"not_submitted",
"submitting",
"accepted",
"needs_review"
]
},
"cryptoPayment": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
},
"tokenId": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"displayAmount": {
"type": "string"
},
"usdTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"usdPrice": {
"type": "string"
},
"priceAsOf": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"source": {
"type": "string"
},
"payTo": {
"type": "string"
},
"quotedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network",
"tokenId",
"amount",
"displayAmount",
"usdTotal",
"usdPrice",
"priceAsOf",
"source",
"payTo",
"quotedAt",
"validUntil"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"transaction": {
"type": [
"string",
"null"
]
},
"network": {
"type": [
"string",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"method",
"price",
"pricingVersion",
"paymentDeadline",
"canEditCoupon",
"quantity",
"createdAt",
"paidAt",
"paymentStatus",
"fulfillmentStatus",
"cryptoPayment",
"transaction",
"network",
"trackingUrls",
"message"
],
"additionalProperties": false
},
"paymentUrl": {
"type": "string"
},
"checkoutUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"order",
"checkoutUrl"
],
"additionalProperties": false
}
}
list_payment_assets
Public: search Base ERC-20 and ready Solana SPL / compatible Token-2022 payment candidates by name, ticker or exact contract/mint. No market-cap limit. Results are paginated; pass nextOffset as offset. Call quote_crypto_payment to verify the token and obtain a fresh price. Solana needs the merchant receiving account initialized.
{
"name": "list_payment_assets",
"title": "List Payment Assets",
"description": "Public: search Base ERC-20 and ready Solana SPL / compatible Token-2022 payment candidates by name, ticker or exact contract/mint. No market-cap limit. Results are paginated; pass nextOffset as offset. Call quote_crypto_payment to verify the token and obtain a fresh price. Solana needs the merchant receiving account initialized.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"search": {
"default": "",
"type": "string",
"maxLength": 100
},
"network": {
"type": "string",
"enum": [
"eip155:8453",
"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"
]
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 20000
},
"limit": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"network": {
"type": "string"
},
"priceStatus": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"rankingSource": {
"type": "string"
},
"catalogUpdatedAt": {
"type": "string"
},
"catalogSource": {
"type": "string",
"enum": [
"bundled",
"refreshed"
]
},
"catalogStale": {
"type": "boolean"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network"
],
"additionalProperties": false
}
},
"networks": {
"type": "array",
"items": {
"type": "string"
}
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"offset": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"nextOffset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"solanaPayTo": {
"type": [
"string",
"null"
]
}
},
"required": [
"network",
"priceStatus",
"rankingSource",
"assets",
"networks",
"total",
"offset",
"nextOffset",
"solanaPayTo"
],
"additionalProperties": false
}
}
quote_crypto_payment
Lock an unpaid order in a listed token for up to 60 seconds. Obtain approval of this exact amount and include cryptoQuoteId in the payment retry.
{
"name": "quote_crypto_payment",
"title": "Quote Crypto Payment",
"description": "Lock an unpaid order in a listed token for up to 60 seconds. Obtain approval of this exact amount and include cryptoQuoteId in the payment retry.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"orderId",
"tokenId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
},
"tokenId": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"displayAmount": {
"type": "string"
},
"usdTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"usdPrice": {
"type": "string"
},
"priceAsOf": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"source": {
"type": "string"
},
"payTo": {
"type": "string"
},
"quotedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network",
"tokenId",
"amount",
"displayAmount",
"usdTotal",
"usdPrice",
"priceAsOf",
"source",
"payTo",
"quotedAt",
"validUntil"
],
"additionalProperties": false
}
}
pay_print_order
Request an x402 v2 challenge without a signature, or settle an approved signature and submit the paid print. Uses the same guarded payment flow as REST. An unsigned call returns payment_required in structuredContent (MCP HTTP 200). Never repay an ambiguous order.
{
"name": "pay_print_order",
"title": "Pay Print Order",
"description": "Request an x402 v2 challenge without a signature, or settle an approved signature and submit the paid print. Uses the same guarded payment flow as REST. An unsigned call returns payment_required in structuredContent (MCP HTTP 200). Never repay an ambiguous order.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"cryptoQuoteId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"paymentSignature": {
"description": "Base64-encoded x402 v2 payload, same value as PAYMENT-SIGNATURE; never provide both.",
"type": "string",
"minLength": 1,
"maxLength": 64000
}
},
"required": [
"orderId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"payment_required",
"order_status"
]
},
"httpStatus": {
"anyOf": [
{
"type": "number",
"const": 200
},
{
"type": "number",
"const": 402
}
]
},
"payment_required": {
"type": "object",
"properties": {
"x402Version": {
"type": "number",
"const": 2
},
"resource": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"description": {
"type": "string"
},
"mimeType": {
"type": "string"
}
},
"required": [
"url"
],
"additionalProperties": false
},
"accepts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"scheme": {
"type": "string",
"const": "exact"
},
"network": {
"type": "string"
},
"asset": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"payTo": {
"type": "string"
},
"maxTimeoutSeconds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"extra": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"scheme",
"network",
"asset",
"amount",
"payTo",
"maxTimeoutSeconds"
],
"additionalProperties": false
}
},
"error": {
"type": "string"
},
"extensions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"x402Version",
"resource",
"accepts"
],
"additionalProperties": false
},
"paymentRequiredHeader": {
"type": "string"
},
"order": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"orderReference": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"creating_checkout",
"awaiting_payment",
"verifying_payment",
"settling_payment",
"paid",
"submitting",
"processing",
"needs_review",
"expired"
]
},
"method": {
"type": "string",
"enum": [
"card",
"x402",
"prepaid"
]
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"pricingVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"paymentDeadline": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"canEditCoupon": {
"type": "boolean"
},
"canRenewCheckout": {
"type": "boolean"
},
"cardPaymentUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cardProcessor": {
"anyOf": [
{
"type": "string",
"enum": [
"square",
"stripe"
]
},
{
"type": "null"
}
]
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"progress": {
"type": "object",
"properties": {
"productionStatus": {
"type": "string",
"enum": [
"not_submitted",
"queued",
"submitting",
"accepted",
"printing",
"shipped",
"delivered",
"cancelled",
"on_hold",
"needs_review",
"unknown"
]
},
"shipmentStatus": {
"type": "string",
"enum": [
"unknown",
"shipped",
"delivered"
]
},
"lastUpdatedAt": {
"type": [
"number",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"supportStatus": {
"type": "string",
"enum": [
"none",
"open",
"waiting_customer",
"under_review",
"resolved"
]
},
"canRequestCancellation": {
"type": "boolean"
},
"canRequestChange": {
"type": "boolean"
},
"canRequestRefund": {
"type": "boolean"
},
"cancellationGuaranteed": {
"type": "boolean",
"const": false
}
},
"required": [
"productionStatus",
"shipmentStatus",
"lastUpdatedAt",
"trackingUrls",
"supportStatus",
"canRequestCancellation",
"canRequestChange",
"canRequestRefund",
"cancellationGuaranteed"
],
"additionalProperties": false
},
"productName": {
"type": "string"
},
"imageCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"paidAt": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
{
"type": "null"
}
]
},
"paymentStatus": {
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
},
"fulfillmentStatus": {
"type": "string",
"enum": [
"not_submitted",
"submitting",
"accepted",
"needs_review"
]
},
"cryptoPayment": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
},
"tokenId": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"displayAmount": {
"type": "string"
},
"usdTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"usdPrice": {
"type": "string"
},
"priceAsOf": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"source": {
"type": "string"
},
"payTo": {
"type": "string"
},
"quotedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network",
"tokenId",
"amount",
"displayAmount",
"usdTotal",
"usdPrice",
"priceAsOf",
"source",
"payTo",
"quotedAt",
"validUntil"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"transaction": {
"type": [
"string",
"null"
]
},
"network": {
"type": [
"string",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"method",
"price",
"pricingVersion",
"paymentDeadline",
"canEditCoupon",
"quantity",
"createdAt",
"paidAt",
"paymentStatus",
"fulfillmentStatus",
"cryptoPayment",
"transaction",
"network",
"trackingUrls",
"message"
],
"additionalProperties": false
},
"paymentResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"transaction": {
"type": "string"
},
"network": {
"type": "string"
},
"payer": {
"type": "string"
},
"errorReason": {
"type": "string"
}
},
"required": [
"success",
"transaction",
"network"
],
"additionalProperties": {}
},
"paymentResponseHeader": {
"type": "string"
}
},
"required": [
"status",
"httpStatus"
],
"additionalProperties": false
}
}
list_photos
List your unexpired, unlocked uploaded photos. Use their IDs in slot order. Photos reserved by an order cannot be deleted.
{
"name": "list_photos",
"title": "List Photos",
"description": "List your unexpired, unlocked uploaded photos. Use their IDs in slot order. Photos reserved by an order cannot be deleted.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"photos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"productId": {
"type": "string"
},
"artworkKey": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"quality": {
"anyOf": [
{
"type": "string",
"enum": [
"high",
"reduced"
]
},
{
"type": "null"
}
]
},
"orientation": {
"type": "string",
"enum": [
"portrait",
"landscape"
]
}
},
"required": [
"id",
"productId",
"artworkKey",
"width",
"height",
"quality",
"orientation"
],
"additionalProperties": false
}
}
},
"required": [
"photos"
],
"additionalProperties": false
}
}
get_photo
Get the private JPEG download endpoint for your uploaded photo. Send the same Bearer credential; this is not a public image URL.
{
"name": "get_photo",
"title": "Get Photo",
"description": "Get the private JPEG download endpoint for your uploaded photo. Send the same Bearer credential; this is not a public image URL.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"photoId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"photoId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "GET"
},
"mimeType": {
"type": "string",
"const": "image/jpeg"
},
"authorization": {
"type": "string"
}
},
"required": [
"url",
"method",
"mimeType",
"authorization"
],
"additionalProperties": false
}
}
delete_photo
Permanently delete one of your uploaded photos. Photos locked or reserved by an order cannot be deleted.
{
"name": "delete_photo",
"title": "Delete Photo",
"description": "Permanently delete one of your uploaded photos. Photos locked or reserved by an order cannot be deleted.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"photoId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"photoId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"const": true
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
preview_print_item
Preview owned photoIds in product slot order. Calendars require startYear/startMonth and include generated grids. Compositions use their configured assembly. Other products return flat artwork pages. JPEG thumbnails accompany metadata; offset/limit paginate. No order or public image link is created.
{
"name": "preview_print_item",
"title": "Preview Print Item",
"description": "Preview owned photoIds in product slot order. Calendars require startYear/startMonth and include generated grids. Compositions use their configured assembly. Other products return flat artwork pages. JPEG thumbnails accompany metadata; offset/limit paginate. No order or public image link is created.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,63}$"
},
"photoIds": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"calendar": {
"type": "object",
"properties": {
"startYear": {
"type": "integer",
"minimum": 2000,
"maximum": 2100
},
"startMonth": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"required": [
"startYear",
"startMonth"
],
"additionalProperties": false
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"default": 4,
"type": "integer",
"minimum": 1,
"maximum": 4
}
},
"required": [
"photoIds"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"productId": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"composition",
"artwork_pages",
"calendar"
]
},
"layoutId": {
"type": [
"string",
"null"
]
},
"totalPages": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"nextOffset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"label": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"index",
"label",
"width",
"height"
],
"additionalProperties": false
}
}
},
"required": [
"productId",
"kind",
"layoutId",
"totalPages",
"nextOffset",
"pages"
],
"additionalProperties": false
}
}
preview_print_price
Estimate product and destination pricing before using the customer’s photos for an order. Uses placeholder artwork and does not create an order or a payable quote. Call quote_prints with buyer consent before checkout.
{
"name": "preview_print_price",
"title": "Preview Print Price",
"description": "Estimate product and destination pricing before using the customer’s photos for an order. Uses placeholder artwork and does not create an order or a payable quote. Call quote_prints with buyer consent before checkout.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,63}$"
},
"items": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"calendar": {
"type": "object",
"properties": {
"startYear": {
"type": "integer",
"minimum": 2000,
"maximum": 2100
},
"startMonth": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"required": [
"startYear",
"startMonth"
],
"additionalProperties": false
},
"productId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,63}$"
},
"photoId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"photoIds": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 99
}
},
"required": [
"quantity"
],
"additionalProperties": false
}
},
"shipping": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"phone": {
"type": "string"
},
"line1": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"line2": {
"default": "",
"type": "string",
"maxLength": 150
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"state": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"zip": {
"type": "string",
"pattern": "^\\d{5}(-\\d{4})?$"
},
"country": {
"type": "string",
"const": "US"
}
},
"required": [
"firstName",
"lastName",
"email",
"phone",
"line1",
"city",
"state",
"zip",
"country"
],
"additionalProperties": false
},
"couponCode": {
"type": "string",
"maxLength": 64
},
"campaignId": {
"type": "string",
"pattern": "^[a-f0-9]{16}$"
}
},
"required": [
"items",
"shipping"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"preview": {
"type": "boolean",
"const": true
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"expiresAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"photoId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"photoIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"productId": {
"type": "string"
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"calendar": {
"type": "object",
"properties": {
"startYear": {
"type": "integer",
"minimum": 2000,
"maximum": 2100
},
"startMonth": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"required": [
"startYear",
"startMonth"
],
"additionalProperties": false
}
},
"required": [
"productId",
"quantity"
],
"additionalProperties": false
}
}
},
"required": [
"preview",
"price",
"validUntil",
"expiresAt",
"lineItems"
],
"additionalProperties": false
}
}
list_orders
Read up to 50 recent owned orders, newest first. Saved state only; no payment reconciliation.
{
"name": "list_orders",
"title": "List Orders",
"description": "Read up to 50 recent owned orders, newest first. Saved state only; no payment reconciliation.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"limit": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"orderReference": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"creating_checkout",
"awaiting_payment",
"verifying_payment",
"settling_payment",
"paid",
"submitting",
"processing",
"needs_review",
"expired"
]
},
"method": {
"type": "string",
"enum": [
"card",
"x402",
"prepaid"
]
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"pricingVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"paymentDeadline": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"canEditCoupon": {
"type": "boolean"
},
"canRenewCheckout": {
"type": "boolean"
},
"cardPaymentUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cardProcessor": {
"anyOf": [
{
"type": "string",
"enum": [
"square",
"stripe"
]
},
{
"type": "null"
}
]
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"progress": {
"type": "object",
"properties": {
"productionStatus": {
"type": "string",
"enum": [
"not_submitted",
"queued",
"submitting",
"accepted",
"printing",
"shipped",
"delivered",
"cancelled",
"on_hold",
"needs_review",
"unknown"
]
},
"shipmentStatus": {
"type": "string",
"enum": [
"unknown",
"shipped",
"delivered"
]
},
"lastUpdatedAt": {
"type": [
"number",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"supportStatus": {
"type": "string",
"enum": [
"none",
"open",
"waiting_customer",
"under_review",
"resolved"
]
},
"canRequestCancellation": {
"type": "boolean"
},
"canRequestChange": {
"type": "boolean"
},
"canRequestRefund": {
"type": "boolean"
},
"cancellationGuaranteed": {
"type": "boolean",
"const": false
}
},
"required": [
"productionStatus",
"shipmentStatus",
"lastUpdatedAt",
"trackingUrls",
"supportStatus",
"canRequestCancellation",
"canRequestChange",
"canRequestRefund",
"cancellationGuaranteed"
],
"additionalProperties": false
},
"productName": {
"type": "string"
},
"imageCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"paidAt": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
{
"type": "null"
}
]
},
"paymentStatus": {
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
},
"fulfillmentStatus": {
"type": "string",
"enum": [
"not_submitted",
"submitting",
"accepted",
"needs_review"
]
},
"cryptoPayment": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
},
"tokenId": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"displayAmount": {
"type": "string"
},
"usdTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"usdPrice": {
"type": "string"
},
"priceAsOf": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"source": {
"type": "string"
},
"payTo": {
"type": "string"
},
"quotedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network",
"tokenId",
"amount",
"displayAmount",
"usdTotal",
"usdPrice",
"priceAsOf",
"source",
"payTo",
"quotedAt",
"validUntil"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"transaction": {
"type": [
"string",
"null"
]
},
"network": {
"type": [
"string",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"method",
"price",
"pricingVersion",
"paymentDeadline",
"canEditCoupon",
"quantity",
"createdAt",
"paidAt",
"paymentStatus",
"fulfillmentStatus",
"cryptoPayment",
"transaction",
"network",
"trackingUrls",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"orders"
],
"additionalProperties": false
}
}
get_checkout_link
Mint a private on-site checkout link for your existing order. Preserve its access fragment, share only with the buyer, and never create another order to recover a checkout. Card payment uses the embedded payment modal; MCP never accepts card details.
{
"name": "get_checkout_link",
"title": "Get Checkout Link",
"description": "Mint a private on-site checkout link for your existing order. Preserve its access fragment, share only with the buyer, and never create another order to recover a checkout. Card payment uses the embedded payment modal; MCP never accepts card details.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
}
},
"required": [
"orderId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"checkoutUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"checkoutUrl"
],
"additionalProperties": false
}
}
update_order_coupon
Apply or remove a coupon on your eligible unpaid x402 order; empty couponCode removes it. Check canEditCoupon first. Returns the revised price and pricingVersion, invalidates old crypto quotes, and never requests payment. Obtain approval of the new total before paying. Card or ambiguous payments cannot be changed.
{
"name": "update_order_coupon",
"title": "Update Order Coupon",
"description": "Apply or remove a coupon on your eligible unpaid x402 order; empty couponCode removes it. Check canEditCoupon first. Returns the revised price and pricingVersion, invalidates old crypto quotes, and never requests payment. Obtain approval of the new total before paying. Card or ambiguous payments cannot be changed.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"couponCode": {
"type": "string",
"maxLength": 64
}
},
"required": [
"orderId",
"couponCode"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"orderReference": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"creating_checkout",
"awaiting_payment",
"verifying_payment",
"settling_payment",
"paid",
"submitting",
"processing",
"needs_review",
"expired"
]
},
"method": {
"type": "string",
"enum": [
"card",
"x402",
"prepaid"
]
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"pricingVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"paymentDeadline": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"canEditCoupon": {
"type": "boolean"
},
"canRenewCheckout": {
"type": "boolean"
},
"cardPaymentUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cardProcessor": {
"anyOf": [
{
"type": "string",
"enum": [
"square",
"stripe"
]
},
{
"type": "null"
}
]
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"progress": {
"type": "object",
"properties": {
"productionStatus": {
"type": "string",
"enum": [
"not_submitted",
"queued",
"submitting",
"accepted",
"printing",
"shipped",
"delivered",
"cancelled",
"on_hold",
"needs_review",
"unknown"
]
},
"shipmentStatus": {
"type": "string",
"enum": [
"unknown",
"shipped",
"delivered"
]
},
"lastUpdatedAt": {
"type": [
"number",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"supportStatus": {
"type": "string",
"enum": [
"none",
"open",
"waiting_customer",
"under_review",
"resolved"
]
},
"canRequestCancellation": {
"type": "boolean"
},
"canRequestChange": {
"type": "boolean"
},
"canRequestRefund": {
"type": "boolean"
},
"cancellationGuaranteed": {
"type": "boolean",
"const": false
}
},
"required": [
"productionStatus",
"shipmentStatus",
"lastUpdatedAt",
"trackingUrls",
"supportStatus",
"canRequestCancellation",
"canRequestChange",
"canRequestRefund",
"cancellationGuaranteed"
],
"additionalProperties": false
},
"productName": {
"type": "string"
},
"imageCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"paidAt": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
{
"type": "null"
}
]
},
"paymentStatus": {
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
},
"fulfillmentStatus": {
"type": "string",
"enum": [
"not_submitted",
"submitting",
"accepted",
"needs_review"
]
},
"cryptoPayment": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
},
"tokenId": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"displayAmount": {
"type": "string"
},
"usdTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"usdPrice": {
"type": "string"
},
"priceAsOf": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"source": {
"type": "string"
},
"payTo": {
"type": "string"
},
"quotedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network",
"tokenId",
"amount",
"displayAmount",
"usdTotal",
"usdPrice",
"priceAsOf",
"source",
"payTo",
"quotedAt",
"validUntil"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"transaction": {
"type": [
"string",
"null"
]
},
"network": {
"type": [
"string",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"method",
"price",
"pricingVersion",
"paymentDeadline",
"canEditCoupon",
"quantity",
"createdAt",
"paidAt",
"paymentStatus",
"fulfillmentStatus",
"cryptoPayment",
"transaction",
"network",
"trackingUrls",
"message"
],
"additionalProperties": false
}
}
confirm_complimentary_order
Explicitly approve fulfillment of your existing zero-total order after a coupon change. Requires buyerApproved:true and the current pricingVersion. Original order terms consent remains required. Idempotent for an already confirmed complimentary order; never use this for a positive total.
{
"name": "confirm_complimentary_order",
"title": "Confirm Complimentary Order",
"description": "Explicitly approve fulfillment of your existing zero-total order after a coupon change. Requires buyerApproved:true and the current pricingVersion. Original order terms consent remains required. Idempotent for an already confirmed complimentary order; never use this for a positive total.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"buyerApproved": {
"type": "boolean",
"const": true
},
"pricingVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"orderId",
"buyerApproved",
"pricingVersion"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"orderReference": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"creating_checkout",
"awaiting_payment",
"verifying_payment",
"settling_payment",
"paid",
"submitting",
"processing",
"needs_review",
"expired"
]
},
"method": {
"type": "string",
"enum": [
"card",
"x402",
"prepaid"
]
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"pricingVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"paymentDeadline": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"canEditCoupon": {
"type": "boolean"
},
"canRenewCheckout": {
"type": "boolean"
},
"cardPaymentUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cardProcessor": {
"anyOf": [
{
"type": "string",
"enum": [
"square",
"stripe"
]
},
{
"type": "null"
}
]
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"progress": {
"type": "object",
"properties": {
"productionStatus": {
"type": "string",
"enum": [
"not_submitted",
"queued",
"submitting",
"accepted",
"printing",
"shipped",
"delivered",
"cancelled",
"on_hold",
"needs_review",
"unknown"
]
},
"shipmentStatus": {
"type": "string",
"enum": [
"unknown",
"shipped",
"delivered"
]
},
"lastUpdatedAt": {
"type": [
"number",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"supportStatus": {
"type": "string",
"enum": [
"none",
"open",
"waiting_customer",
"under_review",
"resolved"
]
},
"canRequestCancellation": {
"type": "boolean"
},
"canRequestChange": {
"type": "boolean"
},
"canRequestRefund": {
"type": "boolean"
},
"cancellationGuaranteed": {
"type": "boolean",
"const": false
}
},
"required": [
"productionStatus",
"shipmentStatus",
"lastUpdatedAt",
"trackingUrls",
"supportStatus",
"canRequestCancellation",
"canRequestChange",
"canRequestRefund",
"cancellationGuaranteed"
],
"additionalProperties": false
},
"productName": {
"type": "string"
},
"imageCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"paidAt": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
{
"type": "null"
}
]
},
"paymentStatus": {
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
},
"fulfillmentStatus": {
"type": "string",
"enum": [
"not_submitted",
"submitting",
"accepted",
"needs_review"
]
},
"cryptoPayment": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
},
"tokenId": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"displayAmount": {
"type": "string"
},
"usdTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"usdPrice": {
"type": "string"
},
"priceAsOf": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"source": {
"type": "string"
},
"payTo": {
"type": "string"
},
"quotedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network",
"tokenId",
"amount",
"displayAmount",
"usdTotal",
"usdPrice",
"priceAsOf",
"source",
"payTo",
"quotedAt",
"validUntil"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"transaction": {
"type": [
"string",
"null"
]
},
"network": {
"type": [
"string",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"method",
"price",
"pricingVersion",
"paymentDeadline",
"canEditCoupon",
"quantity",
"createdAt",
"paidAt",
"paymentStatus",
"fulfillmentStatus",
"cryptoPayment",
"transaction",
"network",
"trackingUrls",
"message"
],
"additionalProperties": false
}
}
lookup_order
Recover by exactly one of orderReference or original idempotencyKey, within the current account/session. Reads saved status only. found:false may race an in-flight commit; paid:null is unknown. Neither authorizes a replacement order or payment.
{
"name": "lookup_order",
"title": "Lookup Order",
"description": "Recover by exactly one of orderReference or original idempotencyKey, within the current account/session. Reads saved status only. found:false may race an in-flight commit; paid:null is unknown. Neither authorizes a replacement order or payment.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderReference": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
"idempotencyKey": {
"type": "string",
"pattern": "^[-\\w]{16,100}$"
}
},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"found": {
"type": "boolean"
},
"order": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"orderReference": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"creating_checkout",
"awaiting_payment",
"verifying_payment",
"settling_payment",
"paid",
"submitting",
"processing",
"needs_review",
"expired"
]
},
"method": {
"type": "string",
"enum": [
"card",
"x402",
"prepaid"
]
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"pricingVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"paymentDeadline": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"canEditCoupon": {
"type": "boolean"
},
"canRenewCheckout": {
"type": "boolean"
},
"cardPaymentUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cardProcessor": {
"anyOf": [
{
"type": "string",
"enum": [
"square",
"stripe"
]
},
{
"type": "null"
}
]
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"progress": {
"type": "object",
"properties": {
"productionStatus": {
"type": "string",
"enum": [
"not_submitted",
"queued",
"submitting",
"accepted",
"printing",
"shipped",
"delivered",
"cancelled",
"on_hold",
"needs_review",
"unknown"
]
},
"shipmentStatus": {
"type": "string",
"enum": [
"unknown",
"shipped",
"delivered"
]
},
"lastUpdatedAt": {
"type": [
"number",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"supportStatus": {
"type": "string",
"enum": [
"none",
"open",
"waiting_customer",
"under_review",
"resolved"
]
},
"canRequestCancellation": {
"type": "boolean"
},
"canRequestChange": {
"type": "boolean"
},
"canRequestRefund": {
"type": "boolean"
},
"cancellationGuaranteed": {
"type": "boolean",
"const": false
}
},
"required": [
"productionStatus",
"shipmentStatus",
"lastUpdatedAt",
"trackingUrls",
"supportStatus",
"canRequestCancellation",
"canRequestChange",
"canRequestRefund",
"cancellationGuaranteed"
],
"additionalProperties": false
},
"productName": {
"type": "string"
},
"imageCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"paidAt": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
{
"type": "null"
}
]
},
"paymentStatus": {
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
},
"fulfillmentStatus": {
"type": "string",
"enum": [
"not_submitted",
"submitting",
"accepted",
"needs_review"
]
},
"cryptoPayment": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
},
"tokenId": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"displayAmount": {
"type": "string"
},
"usdTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"usdPrice": {
"type": "string"
},
"priceAsOf": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"source": {
"type": "string"
},
"payTo": {
"type": "string"
},
"quotedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network",
"tokenId",
"amount",
"displayAmount",
"usdTotal",
"usdPrice",
"priceAsOf",
"source",
"payTo",
"quotedAt",
"validUntil"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"transaction": {
"type": [
"string",
"null"
]
},
"network": {
"type": [
"string",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"method",
"price",
"pricingVersion",
"paymentDeadline",
"canEditCoupon",
"quantity",
"createdAt",
"paidAt",
"paymentStatus",
"fulfillmentStatus",
"cryptoPayment",
"transaction",
"network",
"trackingUrls",
"message"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"paid": {
"type": [
"boolean",
"null"
]
},
"paymentStatus": {
"anyOf": [
{
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
},
{
"type": "null"
}
]
},
"source": {
"type": "string",
"const": "saved_order"
},
"observedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"message": {
"type": "string"
}
},
"required": [
"found",
"order",
"paid",
"paymentStatus",
"source",
"observedAt",
"message"
],
"additionalProperties": false
}
}
get_order
Read saved private order, payment and fulfillment status without charging, reconciling payment or submitting prints. Processing means accepted, not shipped. progress includes explicit shipment state, freshness and tracking. Payment webhooks and scheduled reconciliation update saved status.
{
"name": "get_order",
"title": "Get Order",
"description": "Read saved private order, payment and fulfillment status without charging, reconciling payment or submitting prints. Processing means accepted, not shipped. progress includes explicit shipment state, freshness and tracking. Payment webhooks and scheduled reconciliation update saved status.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
}
},
"required": [
"orderId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"orderReference": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"creating_checkout",
"awaiting_payment",
"verifying_payment",
"settling_payment",
"paid",
"submitting",
"processing",
"needs_review",
"expired"
]
},
"method": {
"type": "string",
"enum": [
"card",
"x402",
"prepaid"
]
},
"price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"subtotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shipping": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"tax": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"originalTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"discount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"coupon": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"printDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"shippingDiscount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"taxCredit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
}
},
"required": [
"code",
"name",
"printDiscount",
"shippingDiscount",
"taxCredit"
],
"additionalProperties": false
}
},
"required": [
"currency",
"subtotal",
"shipping",
"tax",
"total"
],
"additionalProperties": false
},
"pricingVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"paymentDeadline": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"canEditCoupon": {
"type": "boolean"
},
"canRenewCheckout": {
"type": "boolean"
},
"cardPaymentUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cardProcessor": {
"anyOf": [
{
"type": "string",
"enum": [
"square",
"stripe"
]
},
{
"type": "null"
}
]
},
"quantity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"progress": {
"type": "object",
"properties": {
"productionStatus": {
"type": "string",
"enum": [
"not_submitted",
"queued",
"submitting",
"accepted",
"printing",
"shipped",
"delivered",
"cancelled",
"on_hold",
"needs_review",
"unknown"
]
},
"shipmentStatus": {
"type": "string",
"enum": [
"unknown",
"shipped",
"delivered"
]
},
"lastUpdatedAt": {
"type": [
"number",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"supportStatus": {
"type": "string",
"enum": [
"none",
"open",
"waiting_customer",
"under_review",
"resolved"
]
},
"canRequestCancellation": {
"type": "boolean"
},
"canRequestChange": {
"type": "boolean"
},
"canRequestRefund": {
"type": "boolean"
},
"cancellationGuaranteed": {
"type": "boolean",
"const": false
}
},
"required": [
"productionStatus",
"shipmentStatus",
"lastUpdatedAt",
"trackingUrls",
"supportStatus",
"canRequestCancellation",
"canRequestChange",
"canRequestRefund",
"cancellationGuaranteed"
],
"additionalProperties": false
},
"productName": {
"type": "string"
},
"imageCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"paidAt": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
{
"type": "null"
}
]
},
"paymentStatus": {
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
},
"fulfillmentStatus": {
"type": "string",
"enum": [
"not_submitted",
"submitting",
"accepted",
"needs_review"
]
},
"cryptoPayment": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"rankId": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"transferMethod": {
"type": "string",
"enum": [
"eip3009",
"permit2",
"spl"
]
},
"network": {
"type": "string"
},
"tokenProgram": {
"type": "string"
},
"rank": {
"type": [
"number",
"null"
]
},
"wrapped": {
"type": "boolean"
},
"stable": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"quote_required",
"receiving_ready"
]
},
"priceChecked": {
"type": "boolean"
},
"tokenId": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^\\d+$"
},
"displayAmount": {
"type": "string"
},
"usdTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Integer USD cents"
},
"usdPrice": {
"type": "string"
},
"priceAsOf": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"source": {
"type": "string"
},
"payTo": {
"type": "string"
},
"quotedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"validUntil": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
}
},
"required": [
"id",
"rankId",
"name",
"symbol",
"asset",
"decimals",
"transferMethod",
"network",
"tokenId",
"amount",
"displayAmount",
"usdTotal",
"usdPrice",
"priceAsOf",
"source",
"payTo",
"quotedAt",
"validUntil"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"transaction": {
"type": [
"string",
"null"
]
},
"network": {
"type": [
"string",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"method",
"price",
"pricingVersion",
"paymentDeadline",
"canEditCoupon",
"quantity",
"createdAt",
"paidAt",
"paymentStatus",
"fulfillmentStatus",
"cryptoPayment",
"transaction",
"network",
"trackingUrls",
"message"
],
"additionalProperties": false
}
}
estimate_print_price
Estimate configured product and shipping charges using only product, quantity, ZIP and state. No photos or contact details required. Unknown tax or charges remain null; this is not a payable quote.
{
"name": "estimate_print_price",
"title": "Estimate Print Price",
"description": "Estimate configured product and shipping charges using only product, quantity, ZIP and state. No photos or contact details required. Unknown tax or charges remain null; this is not a payable quote.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"productId": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 500
},
"zip": {
"type": "string",
"pattern": "^\\d{5}$"
},
"state": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"productId",
"quantity",
"zip",
"state"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"estimate": {
"type": "boolean",
"const": true
},
"currency": {
"type": "string",
"const": "USD"
},
"productId": {
"type": "string"
},
"quantity": {
"type": "number"
},
"subtotal": {
"type": [
"number",
"null"
]
},
"shipping": {
"type": [
"number",
"null"
]
},
"tax": {
"type": [
"number",
"null"
]
},
"total": {
"type": [
"number",
"null"
]
},
"knownAmount": {
"type": "number"
},
"unknownComponents": {
"type": "array",
"items": {
"type": "string"
}
},
"requiresFinalQuote": {
"type": "boolean",
"const": true
},
"message": {
"type": "string"
}
},
"required": [
"estimate",
"currency",
"productId",
"quantity",
"subtotal",
"shipping",
"tax",
"total",
"knownAmount",
"unknownComponents",
"requiresFinalQuote",
"message"
],
"additionalProperties": false
}
}
get_order_events
Read your customer-safe order events in sequence. Save the last sequence as after for incremental recovery; duplicate events must be deduplicated by orderId and sequence.
{
"name": "get_order_events",
"title": "Get Order Events",
"description": "Read your customer-safe order events in sequence. Save the last sequence as after for incremental recovery; duplicate events must be deduplicated by orderId and sequence.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"after": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"orderId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"sequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"type": {
"type": "string",
"const": "order.updated"
},
"occurredAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"data": {
"type": "object",
"properties": {
"productionStatus": {
"type": "string",
"enum": [
"not_submitted",
"queued",
"submitting",
"accepted",
"printing",
"shipped",
"delivered",
"cancelled",
"on_hold",
"needs_review",
"unknown"
]
},
"shipmentStatus": {
"type": "string",
"enum": [
"unknown",
"shipped",
"delivered"
]
},
"lastUpdatedAt": {
"type": [
"number",
"null"
]
},
"trackingUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"supportStatus": {
"type": "string",
"enum": [
"none",
"open",
"waiting_customer",
"under_review",
"resolved"
]
},
"canRequestCancellation": {
"type": "boolean"
},
"canRequestChange": {
"type": "boolean"
},
"canRequestRefund": {
"type": "boolean"
},
"cancellationGuaranteed": {
"type": "boolean",
"const": false
},
"paymentStatus": {
"type": "string",
"enum": [
"unpaid",
"pending",
"paid",
"refunded",
"not_required",
"needs_review",
"expired"
]
}
},
"required": [
"productionStatus",
"shipmentStatus",
"lastUpdatedAt",
"trackingUrls",
"supportStatus",
"canRequestCancellation",
"canRequestChange",
"canRequestRefund",
"cancellationGuaranteed",
"paymentStatus"
],
"additionalProperties": false
}
},
"required": [
"id",
"orderId",
"sequence",
"type",
"occurredAt",
"data"
],
"additionalProperties": false
}
},
"nextCursor": {
"type": [
"number",
"null"
]
}
},
"required": [
"events",
"nextCursor"
],
"additionalProperties": false
}
}
request_order_help
Create an order-bound support, address-change, cancellation or refund REQUEST. Requires buyer authorization. No cancellation, refund or change is executed or guaranteed. Reuse idempotencyKey when retrying the same request; read progress capability flags first.
{
"name": "request_order_help",
"title": "Request Order Help",
"description": "Create an order-bound support, address-change, cancellation or refund REQUEST. Requires buyer authorization. No cancellation, refund or change is executed or guaranteed. Reuse idempotencyKey when retrying the same request; read progress capability flags first.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"type": {
"type": "string",
"enum": [
"general",
"address",
"cancellation",
"refund",
"damaged_prints",
"late_delivery"
]
},
"message": {
"type": "string",
"minLength": 10,
"maxLength": 2000
},
"idempotencyKey": {
"type": "string",
"pattern": "^[\\w-]{16,100}$"
}
},
"required": [
"orderId",
"type",
"message",
"idempotencyKey"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"status": {
"type": "string",
"const": "requested"
},
"type": {
"type": "string"
},
"createdAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
"message": {
"type": "string"
}
},
"required": [
"reference",
"status",
"type",
"createdAt",
"message"
],
"additionalProperties": false
}
}
subscribe_order_events
Subscribe an owned order to an HTTPS webhook you control. Requires permission to send this order status to that endpoint. Returns a signing secret once. At-least-once delivery; verify timestamp/signature and deduplicate orderId + sequence. Repeated failures pause delivery; use event history for recovery.
{
"name": "subscribe_order_events",
"title": "Subscribe Order Events",
"description": "Subscribe an owned order to an HTTPS webhook you control. Requires permission to send this order status to that endpoint. Returns a signing secret once. At-least-once delivery; verify timestamp/signature and deduplicate orderId + sequence. Repeated failures pause delivery; use event history for recovery.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
}
},
"required": [
"orderId",
"url"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"secret": {
"type": "string"
},
"url": {
"type": "string"
},
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"signature": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"id",
"secret",
"url",
"orderId",
"signature",
"message"
],
"additionalProperties": false
}
}
list_order_subscriptions
List your webhook destinations and delivery status for an owned order. Signing secrets are never returned.
{
"name": "list_order_subscriptions",
"title": "List Order Subscriptions",
"description": "List your webhook destinations and delivery status for an owned order. Signing secrets are never returned.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
}
},
"required": [
"orderId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"active": {
"type": "boolean"
},
"cursor": {
"type": "number"
},
"deliveryStatus": {
"type": "string"
},
"lastDeliveredAt": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Unix time in milliseconds"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"url",
"active",
"cursor",
"deliveryStatus",
"lastDeliveredAt"
],
"additionalProperties": false
}
}
},
"required": [
"subscriptions"
],
"additionalProperties": false
}
}
replay_order_events
Resume a failed subscription or replay events after a saved sequence. Requires authorization to resend order status to the registered destination; no payments or orders are repeated.
{
"name": "replay_order_events",
"title": "Replay Order Events",
"description": "Resume a failed subscription or replay events after a saved sequence. Requires authorization to resend order status to the registered destination; no payments or orders are repeated.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"subscriptionId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
},
"after": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"subscriptionId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"const": true
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
unsubscribe_order_events
Disable one of your webhook subscriptions and erase its signing secret.
{
"name": "unsubscribe_order_events",
"title": "Unsubscribe Order Events",
"description": "Disable one of your webhook subscriptions and erase its signing secret.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"subscriptionId": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
}
},
"required": [
"subscriptionId"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"const": true
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
prepare_production_application
Create a complete private draft without applicant sign-in. Supply reviewEmail when the authorized reviewer has a different email from contactEmail. Supply completed sandbox evidence before its token expires; the saved evidence lasts 90 days. reviewNonce must be a private random 64-hex value retained for preparation retries, never a review link. Save draftId and draftToken. No account, application, email or payment is created by this call.
{
"name": "prepare_production_application",
"title": "Prepare a production application",
"description": "Create a complete private draft without applicant sign-in. Supply reviewEmail when the authorized reviewer has a different email from contactEmail. Supply completed sandbox evidence before its token expires; the saved evidence lasts 90 days. reviewNonce must be a private random 64-hex value retained for preparation retries, never a review link. Save draftId and draftToken. No account, application, email or payment is created by this call.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{16,100}$"
},
"integrationName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"legalName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"entityType": {
"type": "string",
"enum": [
"company",
"nonprofit",
"sole_proprietor",
"individual"
]
},
"registrationId": {
"default": "",
"type": "string",
"maxLength": 100
},
"jurisdiction": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"businessAddress": {
"type": "object",
"properties": {
"line1": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"line2": {
"default": "",
"type": "string",
"maxLength": 200
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"region": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"line1",
"city",
"region",
"postalCode",
"country"
],
"additionalProperties": false
},
"website": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"contactName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"contactRole": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"contactEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"contactPhone": {
"type": "string",
"minLength": 7,
"maxLength": 40
},
"technicalEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"securityEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"useCase": {
"type": "string",
"minLength": 30,
"maxLength": 3000
},
"customerAudience": {
"type": "string",
"minLength": 10,
"maxLength": 1000
},
"expectedMonthlyOrders": {
"type": "integer",
"minimum": 1,
"maximum": 10000000
},
"requestedScopes": {
"minItems": 1,
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"mcp:read",
"mcp:write",
"mcp:orders",
"mcp:payments"
]
}
},
"dataHandling": {
"type": "string",
"minLength": 30,
"maxLength": 3000
},
"retentionDays": {
"type": "integer",
"minimum": 0,
"maximum": 3650
},
"privacyPolicyUrl": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"sandboxOrderId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sandboxToken": {
"type": "string",
"pattern": "^pps_[a-f0-9]{64}$"
},
"clientId": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"reviewNonce": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"reviewEmail": {
"anyOf": [
{
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "null"
}
],
"description": "Send review link to. Optional email of the person authorized to confirm the application. Defaults to the business contact. On an update, omit to keep the selection or pass null to use the contact email."
}
},
"required": [
"idempotencyKey",
"integrationName",
"legalName",
"entityType",
"jurisdiction",
"businessAddress",
"website",
"contactName",
"contactRole",
"contactEmail",
"contactPhone",
"technicalEmail",
"securityEmail",
"useCase",
"customerAudience",
"expectedMonthlyOrders",
"requestedScopes",
"dataHandling",
"retentionDays",
"privacyPolicyUrl",
"sandboxOrderId",
"sandboxToken",
"clientId",
"reviewNonce"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string"
},
"version": {
"type": "number"
},
"status": {
"type": "string"
},
"applicationReceived": {
"type": "boolean"
},
"applicationId": {
"type": [
"string",
"null"
]
},
"applicationStatus": {
"type": [
"string",
"null"
]
},
"evidenceValidUntil": {
"type": "number"
},
"reviewEmail": {
"type": "string"
},
"reviewEmailStatus": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"draftToken": {
"type": "string"
}
},
"required": [
"draftId",
"version",
"status",
"applicationReceived",
"applicationId",
"applicationStatus",
"evidenceValidUntil",
"reviewEmail",
"reviewEmailStatus",
"nextAction"
],
"additionalProperties": false
}
}
update_production_application_draft
At the current version, supply complete editable fields or just fields.reviewEmail to change the recipient. Omit fields.reviewEmail to retain the selection or set it to null to use the business contact. Invalidates prior review links and consent. Send a fresh review email afterward. A version locked for payment cannot be changed; recover it or contact support.
{
"name": "update_production_application_draft",
"title": "Correct an application draft",
"description": "At the current version, supply complete editable fields or just fields.reviewEmail to change the recipient. Omit fields.reviewEmail to retain the selection or set it to null to use the business contact. Invalidates prior review links and consent. Send a fresh review email afterward. A version locked for payment cannot be changed; recover it or contact support.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"draftToken": {
"type": "string",
"pattern": "^ppd_[a-f0-9]{64}$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"fields": {
"anyOf": [
{
"type": "object",
"properties": {
"integrationName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"legalName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"entityType": {
"type": "string",
"enum": [
"company",
"nonprofit",
"sole_proprietor",
"individual"
]
},
"registrationId": {
"default": "",
"type": "string",
"maxLength": 100
},
"jurisdiction": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"businessAddress": {
"type": "object",
"properties": {
"line1": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"line2": {
"default": "",
"type": "string",
"maxLength": 200
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"region": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"line1",
"city",
"region",
"postalCode",
"country"
],
"additionalProperties": false
},
"website": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"contactName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"contactRole": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"contactEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"contactPhone": {
"type": "string",
"minLength": 7,
"maxLength": 40
},
"technicalEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"securityEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"useCase": {
"type": "string",
"minLength": 30,
"maxLength": 3000
},
"customerAudience": {
"type": "string",
"minLength": 10,
"maxLength": 1000
},
"expectedMonthlyOrders": {
"type": "integer",
"minimum": 1,
"maximum": 10000000
},
"requestedScopes": {
"minItems": 1,
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"mcp:read",
"mcp:write",
"mcp:orders",
"mcp:payments"
]
}
},
"dataHandling": {
"type": "string",
"minLength": 30,
"maxLength": 3000
},
"retentionDays": {
"type": "integer",
"minimum": 0,
"maximum": 3650
},
"privacyPolicyUrl": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"reviewEmail": {
"anyOf": [
{
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "null"
}
],
"description": "Send review link to. Optional email of the person authorized to confirm the application. Defaults to the business contact. On an update, omit to keep the selection or pass null to use the contact email."
}
},
"required": [
"integrationName",
"legalName",
"entityType",
"jurisdiction",
"businessAddress",
"website",
"contactName",
"contactRole",
"contactEmail",
"contactPhone",
"technicalEmail",
"securityEmail",
"useCase",
"customerAudience",
"expectedMonthlyOrders",
"requestedScopes",
"dataHandling",
"retentionDays",
"privacyPolicyUrl"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"reviewEmail": {
"anyOf": [
{
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "null"
}
],
"description": "Send review link to. Optional email of the person authorized to confirm the application. Defaults to the business contact. On an update, omit to keep the selection or pass null to use the contact email."
}
},
"required": [
"reviewEmail"
],
"additionalProperties": false
}
]
}
},
"required": [
"draftId",
"draftToken",
"version",
"fields"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string"
},
"version": {
"type": "number"
},
"status": {
"type": "string"
},
"applicationReceived": {
"type": "boolean"
},
"applicationId": {
"type": [
"string",
"null"
]
},
"applicationStatus": {
"type": [
"string",
"null"
]
},
"evidenceValidUntil": {
"type": "number"
},
"reviewEmail": {
"type": "string"
},
"reviewEmailStatus": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"draftToken": {
"type": "string"
}
},
"required": [
"draftId",
"version",
"status",
"applicationReceived",
"applicationId",
"applicationStatus",
"evidenceValidUntil",
"reviewEmail",
"reviewEmailStatus",
"nextAction"
],
"additionalProperties": false
}
}
request_production_application_review
Send the current version to the saved reviewEmail (defaults to contactEmail). Requires your private draft capability and a stable request idempotencyKey. The applicant confirms and pays the displayed refundable deposit on site before administrator submission. No review secret is returned to the agent. Report reviewEmailStatus accurately; uncertain delivery may require an explicitly requested fresh email.
{
"name": "request_production_application_review",
"title": "Email applicant review",
"description": "Send the current version to the saved reviewEmail (defaults to contactEmail). Requires your private draft capability and a stable request idempotencyKey. The applicant confirms and pays the displayed refundable deposit on site before administrator submission. No review secret is returned to the agent. Report reviewEmailStatus accurately; uncertain delivery may require an explicitly requested fresh email.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"draftToken": {
"type": "string",
"pattern": "^ppd_[a-f0-9]{64}$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"pattern": "^[\\w-]{16,100}$"
}
},
"required": [
"draftId",
"draftToken",
"version",
"idempotencyKey"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string"
},
"version": {
"type": "number"
},
"status": {
"type": "string"
},
"applicationReceived": {
"type": "boolean"
},
"applicationId": {
"type": [
"string",
"null"
]
},
"applicationStatus": {
"type": [
"string",
"null"
]
},
"evidenceValidUntil": {
"type": "number"
},
"reviewEmail": {
"type": "string"
},
"reviewEmailStatus": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"draftToken": {
"type": "string"
}
},
"required": [
"draftId",
"version",
"status",
"applicationReceived",
"applicationId",
"applicationStatus",
"evidenceValidUntil",
"reviewEmail",
"reviewEmailStatus",
"nextAction"
],
"additionalProperties": false
}
}
resend_production_application_review
Send a fresh private review link to the saved reviewEmail for the current draft version, invalidating earlier links. Reuse the same idempotencyKey after a timeout; use a new key only for an intentional new send. Requires prior review email and a one-minute cooldown. Pending delivery must finish first. For uncertain delivery, acknowledgePossibleDuplicate:true requires authorization for a possible duplicate. Does not submit, pay or approve an application.
{
"name": "resend_production_application_review",
"title": "Resend applicant review email",
"description": "Send a fresh private review link to the saved reviewEmail for the current draft version, invalidating earlier links. Reuse the same idempotencyKey after a timeout; use a new key only for an intentional new send. Requires prior review email and a one-minute cooldown. Pending delivery must finish first. For uncertain delivery, acknowledgePossibleDuplicate:true requires authorization for a possible duplicate. Does not submit, pay or approve an application.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"draftToken": {
"type": "string",
"pattern": "^ppd_[a-f0-9]{64}$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"pattern": "^[\\w-]{16,100}$"
},
"acknowledgePossibleDuplicate": {
"default": false,
"type": "boolean"
}
},
"required": [
"draftId",
"draftToken",
"version",
"idempotencyKey"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string"
},
"version": {
"type": "number"
},
"status": {
"type": "string"
},
"applicationReceived": {
"type": "boolean"
},
"applicationId": {
"type": [
"string",
"null"
]
},
"applicationStatus": {
"type": [
"string",
"null"
]
},
"evidenceValidUntil": {
"type": "number"
},
"reviewEmail": {
"type": "string"
},
"reviewEmailStatus": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"draftToken": {
"type": "string"
}
},
"required": [
"draftId",
"version",
"status",
"applicationReceived",
"applicationId",
"applicationStatus",
"evidenceValidUntil",
"reviewEmail",
"reviewEmailStatus",
"nextAction"
],
"additionalProperties": false
}
}
get_production_application_draft
Read only the status of the draft you prepared using its private capability. applicationReceived=false means no recorded administrator application. After applicant confirmation and verified refundable-deposit payment, return the applicationId and status; pending means awaiting review. Recover this receipt after interruptions instead of preparing a duplicate.
{
"name": "get_production_application_draft",
"title": "Read draft or submission receipt",
"description": "Read only the status of the draft you prepared using its private capability. applicationReceived=false means no recorded administrator application. After applicant confirmation and verified refundable-deposit payment, return the applicationId and status; pending means awaiting review. Recover this receipt after interruptions instead of preparing a duplicate.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"draftToken": {
"type": "string",
"pattern": "^ppd_[a-f0-9]{64}$"
}
},
"required": [
"draftId",
"draftToken"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"draftId": {
"type": "string"
},
"version": {
"type": "number"
},
"status": {
"type": "string"
},
"applicationReceived": {
"type": "boolean"
},
"applicationId": {
"type": [
"string",
"null"
]
},
"applicationStatus": {
"type": [
"string",
"null"
]
},
"evidenceValidUntil": {
"type": "number"
},
"reviewEmail": {
"type": "string"
},
"reviewEmailStatus": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"draftToken": {
"type": "string"
}
},
"required": [
"draftId",
"version",
"status",
"applicationReceived",
"applicationId",
"applicationStatus",
"evidenceValidUntil",
"reviewEmail",
"reviewEmailStatus",
"nextAction"
],
"additionalProperties": false
}
}
get_commercial_balance
Read available, held and reserved USD credit and optional refill state. Use accountUrl for owner-authorized funding or refill settings. Never send card details in chat.
{
"name": "get_commercial_balance",
"title": "Read prepaid account",
"description": "Read available, held and reserved USD credit and optional refill state. Use accountUrl for owner-authorized funding or refill settings. Never send card details in chat.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"currency": {
"type": "string",
"const": "USD"
},
"state": {
"type": "string"
},
"availableCents": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"heldCents": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"reservedCents": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"refillVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"refill": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"thresholdCents": {
"type": "number"
},
"amountCents": {
"type": "number"
},
"dailyLimitCents": {
"type": "number"
}
},
"required": [
"enabled"
],
"additionalProperties": false
},
"paymentMethod": {
"anyOf": [
{
"type": "object",
"properties": {
"last4": {
"type": "string"
},
"brand": {
"type": "string"
}
},
"required": [
"last4",
"brand"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"refillStatus": {
"type": "string"
},
"refillInFlight": {
"type": "boolean"
},
"accountUrl": {
"type": "string"
}
},
"required": [
"applicationId",
"currency",
"state",
"availableCents",
"heldCents",
"reservedCents",
"refillVersion",
"refill",
"paymentMethod",
"refillStatus",
"refillInFlight",
"accountUrl"
],
"additionalProperties": false
}
}
get_commercial_transactions
Recover immutable account movements using nextCursor for pages and resumeCursor for later polling. Sequence is monotonic per account. No supplier costs or card credentials are returned. Order event subscriptions and recovery remain available through get_order_events.
{
"name": "get_commercial_transactions",
"title": "Read prepaid ledger",
"description": "Recover immutable account movements using nextCursor for pages and resumeCursor for later polling. Sequence is monotonic per account. No supplier costs or card credentials are returned. Order event subscriptions and recovery remain available through get_order_events.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"type": "string",
"maxLength": 500
}
},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"sequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"amountCents": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"const": "USD"
},
"at": {
"type": "number"
},
"orderId": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"kind",
"sequence",
"amountCents",
"currency",
"at",
"orderId"
],
"additionalProperties": false
}
},
"resumeCursor": {
"type": [
"string",
"null"
]
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"required": [
"applicationId",
"entries",
"resumeCursor",
"nextCursor"
],
"additionalProperties": false
}
}
get_production_access_options
Public application requirements and the isolated test-to-production workflow. For production onboarding, continue after sandbox through authorized submission and a verified application receipt; sandbox-only requests stop after the simulation.
{
"name": "get_production_access_options",
"title": "Commercial access requirements",
"description": "Public application requirements and the isolated test-to-production workflow. For production onboarding, continue after sandbox through authorized submission and a verified application receipt; sandbox-only requests stop after the simulation.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"applicationTool": {
"type": "string"
},
"reviewEmailTool": {
"type": "string"
},
"reviewEmailResendTool": {
"type": "string"
},
"reviewRecipientField": {
"type": "string"
},
"statusTool": {
"type": "string"
},
"credentialTool": {
"type": "string"
},
"authentication": {
"type": "string"
},
"testRequirement": {
"type": "string"
},
"paymentRequirement": {
"type": "string"
},
"applicationUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"privacyUrl": {
"type": "string"
},
"adminReviewRequired": {
"type": "boolean"
},
"notificationRecipients": {
"type": "array",
"items": {
"type": "string"
}
},
"credentialNotice": {
"type": "string"
}
},
"required": [
"applicationTool",
"reviewEmailTool",
"reviewEmailResendTool",
"reviewRecipientField",
"statusTool",
"credentialTool",
"authentication",
"testRequirement",
"paymentRequirement",
"applicationUrl",
"termsUrl",
"privacyUrl",
"adminReviewRequired",
"notificationRecipients",
"credentialNotice"
],
"additionalProperties": false
}
}
request_production_access
After successful sandbox checkout and verified-account connection, submit legal identity, contact, use case, requested scopes, data handling and sandbox evidence only with explicit authorization for submission and all attestations. Save the returned id and call get_production_access_application with that applicationId to verify receipt. Report pending as awaiting review. Store the idempotency key; after interruption check receipt before retrying the identical application. Never include payment credentials or identity documents.
{
"name": "request_production_access",
"title": "Apply for commercial production access",
"description": "After successful sandbox checkout and verified-account connection, submit legal identity, contact, use case, requested scopes, data handling and sandbox evidence only with explicit authorization for submission and all attestations. Save the returned id and call get_production_access_application with that applicationId to verify receipt. Report pending as awaiting review. Store the idempotency key; after interruption check receipt before retrying the identical application. Never include payment credentials or identity documents.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{16,100}$"
},
"integrationName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"legalName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"entityType": {
"type": "string",
"enum": [
"company",
"nonprofit",
"sole_proprietor",
"individual"
]
},
"registrationId": {
"default": "",
"type": "string",
"maxLength": 100
},
"jurisdiction": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"businessAddress": {
"type": "object",
"properties": {
"line1": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"line2": {
"default": "",
"type": "string",
"maxLength": 200
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"region": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"line1",
"city",
"region",
"postalCode",
"country"
],
"additionalProperties": false
},
"website": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"contactName": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"contactRole": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^\\r\\n\\x00-\\x1f]+$"
},
"contactEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"contactPhone": {
"type": "string",
"minLength": 7,
"maxLength": 40
},
"technicalEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"securityEmail": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"useCase": {
"type": "string",
"minLength": 30,
"maxLength": 3000
},
"customerAudience": {
"type": "string",
"minLength": 10,
"maxLength": 1000
},
"expectedMonthlyOrders": {
"type": "integer",
"minimum": 1,
"maximum": 10000000
},
"requestedScopes": {
"minItems": 1,
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"mcp:read",
"mcp:write",
"mcp:orders",
"mcp:payments"
]
}
},
"dataHandling": {
"type": "string",
"minLength": 30,
"maxLength": 3000
},
"retentionDays": {
"type": "integer",
"minimum": 0,
"maximum": 3650
},
"privacyPolicyUrl": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"sandboxOrderId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sandboxToken": {
"type": "string",
"pattern": "^pps_[a-f0-9]{64}$"
},
"authorizedRepresentative": {
"type": "boolean",
"const": true
},
"acceptsApiTerms": {
"type": "boolean",
"const": true
},
"acceptsAbusePolicy": {
"type": "boolean",
"const": true
}
},
"required": [
"idempotencyKey",
"integrationName",
"legalName",
"entityType",
"jurisdiction",
"businessAddress",
"website",
"contactName",
"contactRole",
"contactEmail",
"contactPhone",
"technicalEmail",
"securityEmail",
"useCase",
"customerAudience",
"expectedMonthlyOrders",
"requestedScopes",
"dataHandling",
"retentionDays",
"privacyPolicyUrl",
"sandboxOrderId",
"sandboxToken",
"authorizedRepresentative",
"acceptsApiTerms",
"acceptsAbusePolicy"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"rejected",
"revoked"
]
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"integrationName": {
"type": "string"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
},
"sandboxVerified": {
"type": "boolean"
},
"requestedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"decisionReason": {
"type": [
"string",
"null"
]
},
"credentialsIssued": {
"type": "boolean"
},
"keyVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"keyExpiresAt": {
"type": [
"number",
"null"
]
},
"quota": {
"type": "object",
"properties": {
"dailyOrderLimit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"dailyOrderLimit",
"version"
],
"additionalProperties": false
}
},
"required": [
"id",
"status",
"version",
"integrationName",
"createdAt",
"updatedAt",
"sandboxVerified",
"requestedScopes",
"decisionReason",
"credentialsIssued",
"keyVersion",
"keyExpiresAt",
"quota"
],
"additionalProperties": false
}
}
get_production_access_application
Verify the application receipt immediately after request_production_access, using its returned id as applicationId. Report the verified application ID and status; pending means awaiting review. Also recover after interrupted submission: omit applicationId to find this connection's application. A timeout or authorization failure leaves receipt unverified; do not claim no application exists without a successful lookup confirming absence.
{
"name": "get_production_access_application",
"title": "Read commercial application",
"description": "Verify the application receipt immediately after request_production_access, using its returned id as applicationId. Report the verified application ID and status; pending means awaiting review. Also recover after interrupted submission: omit applicationId to find this connection's application. A timeout or authorization failure leaves receipt unverified; do not claim no application exists without a successful lookup confirming absence.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"rejected",
"revoked"
]
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"integrationName": {
"type": "string"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
},
"sandboxVerified": {
"type": "boolean"
},
"requestedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"decisionReason": {
"type": [
"string",
"null"
]
},
"credentialsIssued": {
"type": "boolean"
},
"keyVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"keyExpiresAt": {
"type": [
"number",
"null"
]
},
"quota": {
"type": "object",
"properties": {
"dailyOrderLimit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"dailyOrderLimit",
"version"
],
"additionalProperties": false
}
},
"required": [
"id",
"status",
"version",
"integrationName",
"createdAt",
"updatedAt",
"sandboxVerified",
"requestedScopes",
"decisionReason",
"credentialsIssued",
"keyVersion",
"keyExpiresAt",
"quota"
],
"additionalProperties": false
}
}
issue_production_key
Only an approved applicant can issue a scoped 90-day credential. Secret is returned once. After a lost response read application status; rotate explicitly with the current keyVersion to invalidate the old key. Do not display secrets in customer messages.
{
"name": "issue_production_key",
"title": "Issue commercial production credential",
"description": "Only an approved applicant can issue a scoped 90-day credential. Secret is returned once. After a lost response read application status; rotate explicitly with the current keyVersion to invalidate the old key. Do not display secrets in customer messages.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"keyVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rotate": {
"default": false,
"type": "boolean"
}
},
"required": [
"applicationId",
"keyVersion"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"token": {
"type": "string"
},
"expiresAt": {
"type": "number"
},
"keyVersion": {
"type": "number"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"endpoint": {
"type": "string"
},
"notice": {
"type": "string"
}
},
"required": [
"token",
"expiresAt",
"keyVersion",
"scopes",
"endpoint",
"notice"
],
"additionalProperties": false
}
}
revoke_production_key
Invalidate your current commercial credential without changing consumer integrations or deleting paid orders. Requires the application-management OAuth connection.
{
"name": "revoke_production_key",
"title": "Revoke commercial credential",
"description": "Invalidate your current commercial credential without changing consumer integrations or deleting paid orders. Requires the application-management OAuth connection.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"keyVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"applicationId",
"keyVersion"
],
"additionalProperties": false
},
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}