{ "components": { "schemas": { "AdminSessionStatus": { "additionalProperties": false, "properties": { "authenticated": { "type": "boolean" }, "csrfToken": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" } }, "required": [ "authenticated" ], "type": "object" }, "AgentProductImportAdvanceCounts": { "additionalProperties": false, "properties": { "candidateCount": { "format": "int64", "type": "integer" }, "createdProposalCount": { "format": "int64", "type": "integer" }, "createdValidationCount": { "format": "int64", "type": "integer" }, "pendingAIExtractionCount": { "format": "int64", "type": "integer" }, "proposalCount": { "format": "int64", "type": "integer" }, "sourceCount": { "format": "int64", "type": "integer" }, "validationCount": { "format": "int64", "type": "integer" } }, "required": [ "sourceCount", "candidateCount", "proposalCount", "validationCount", "pendingAIExtractionCount", "createdProposalCount", "createdValidationCount" ], "type": "object" }, "AgentProductImportAdvanceNextAction": { "additionalProperties": false, "properties": { "candidateArtifactId": { "type": "string" }, "message": { "type": "string" }, "sourceArtifactId": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "message" ], "type": "object" }, "AgentProductImportAdvanceRequest": { "additionalProperties": false, "properties": { "candidateArtifactIds": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "createApprovals": { "type": "boolean" }, "sourceArtifactIds": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "AgentProductImportAdvanceResult": { "additionalProperties": false, "properties": { "approvalResult": { "$ref": "#/components/schemas/AgentProductImportApprovalBatchResult" }, "counts": { "$ref": "#/components/schemas/AgentProductImportAdvanceCounts" }, "createdProposalArtifacts": { "items": { "$ref": "#/components/schemas/Artifact" }, "type": [ "array", "null" ] }, "createdValidationReports": { "items": { "$ref": "#/components/schemas/Artifact" }, "type": [ "array", "null" ] }, "nextActions": { "items": { "$ref": "#/components/schemas/AgentProductImportAdvanceNextAction" }, "type": [ "array", "null" ] }, "skillRun": { "$ref": "#/components/schemas/SkillRun" }, "skipped": { "items": { "$ref": "#/components/schemas/AgentProductImportAdvanceSkippedArtifact" }, "type": [ "array", "null" ] }, "workbench": { "$ref": "#/components/schemas/AgentProductImportWorkbench" } }, "required": [ "skillRun", "counts" ], "type": "object" }, "AgentProductImportAdvanceSkippedArtifact": { "additionalProperties": false, "properties": { "artifactId": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "reason" ], "type": "object" }, "AgentProductImportApprovalActionBatchRequest": { "additionalProperties": false, "properties": { "approvalIds": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "decision": { "type": "string" } }, "type": "object" }, "AgentProductImportApprovalActionBatchResult": { "additionalProperties": false, "properties": { "approvals": { "items": { "$ref": "#/components/schemas/Approval" }, "type": [ "array", "null" ] }, "failed": { "format": "int64", "type": "integer" }, "items": { "description": "Per-approval batch action outcomes; correlate entries by approvalId.", "items": { "$ref": "#/components/schemas/AgentProductImportApprovalActionItem" }, "type": [ "array", "null" ] }, "page": { "$ref": "#/components/schemas/AgentProductImportApprovalActionPage" }, "processed": { "format": "int64", "type": "integer" }, "skillRun": { "$ref": "#/components/schemas/SkillRun" }, "skipped": { "items": { "$ref": "#/components/schemas/AgentProductImportApprovalBatchSkip" }, "type": [ "array", "null" ] } }, "required": [ "skillRun", "approvals", "processed", "page" ], "type": "object" }, "AgentProductImportApprovalActionItem": { "additionalProperties": false, "properties": { "approvalId": { "description": "Approval ID when known.", "type": "string" }, "reason": { "description": "Human-readable detail when skipped or failed.", "type": "string" }, "result": { "description": "Action outcome: processed, skipped, or failed.", "type": "string" }, "status": { "description": "Approval status after the action, when applicable.", "type": "string" } }, "required": [ "result" ], "type": "object" }, "AgentProductImportApprovalActionPage": { "additionalProperties": false, "properties": { "selected": { "format": "int64", "type": "integer" }, "totalApprovals": { "format": "int64", "type": "integer" } }, "required": [ "totalApprovals", "selected" ], "type": "object" }, "AgentProductImportApprovalApplyBatchRequest": { "additionalProperties": false, "properties": { "approvalIds": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "AgentProductImportApprovalBatchRequest": { "additionalProperties": false, "properties": { "proposalArtifactIds": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "AgentProductImportApprovalBatchResult": { "additionalProperties": false, "properties": { "approvals": { "items": { "$ref": "#/components/schemas/Approval" }, "type": [ "array", "null" ] }, "created": { "format": "int64", "type": "integer" }, "page": { "$ref": "#/components/schemas/AgentProductImportApprovalBatchResultPage" }, "reused": { "format": "int64", "type": "integer" }, "skillRun": { "$ref": "#/components/schemas/SkillRun" }, "skipped": { "items": { "$ref": "#/components/schemas/AgentProductImportApprovalBatchSkip" }, "type": [ "array", "null" ] } }, "required": [ "skillRun", "approvals", "created", "reused", "page" ], "type": "object" }, "AgentProductImportApprovalBatchResultPage": { "additionalProperties": false, "properties": { "selected": { "format": "int64", "type": "integer" }, "totalProposals": { "format": "int64", "type": "integer" } }, "required": [ "totalProposals", "selected" ], "type": "object" }, "AgentProductImportApprovalBatchSkip": { "additionalProperties": false, "properties": { "approvalId": { "type": "string" }, "proposalArtifactId": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "reason" ], "type": "object" }, "AgentProductImportApprovalView": { "additionalProperties": false, "properties": { "action": { "type": "string" }, "id": { "type": "string" }, "requestHash": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status", "action", "requestHash" ], "type": "object" }, "AgentProductImportWorkbench": { "additionalProperties": false, "properties": { "counts": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" }, "page": { "$ref": "#/components/schemas/AgentProductImportWorkbenchPage" }, "rows": { "items": { "$ref": "#/components/schemas/AgentProductImportWorkbenchRow" }, "type": [ "array", "null" ] }, "skillRun": { "$ref": "#/components/schemas/SkillRun" }, "sources": { "items": { "$ref": "#/components/schemas/AgentProductImportWorkbenchSource" }, "type": [ "array", "null" ] }, "summary": { "$ref": "#/components/schemas/AgentProductImportWorkbenchSummary" }, "validationReports": { "items": { "$ref": "#/components/schemas/AgentProductImportWorkbenchValidation" }, "type": [ "array", "null" ] } }, "required": [ "skillRun", "sources", "rows", "counts", "summary", "page" ], "type": "object" }, "AgentProductImportWorkbenchPage": { "additionalProperties": false, "properties": { "limit": { "description": "Requested row page size (0 means no limit).", "format": "int64", "type": "integer" }, "offset": { "description": "Requested row offset into the filtered result set.", "format": "int64", "type": "integer" }, "returnedRows": { "description": "Proposal rows returned in this response page.", "format": "int64", "type": "integer" }, "status": { "description": "Active row status filter, if any.", "type": "string" }, "totalRows": { "description": "Proposal rows after status filter, before limit/offset pagination.", "format": "int64", "type": "integer" } }, "required": [ "offset", "totalRows", "returnedRows" ], "type": "object" }, "AgentProductImportWorkbenchRow": { "additionalProperties": false, "properties": { "approval": { "$ref": "#/components/schemas/AgentProductImportApprovalView" }, "candidateArtifactId": { "type": "string" }, "draft": { "additionalProperties": {}, "type": "object" }, "fieldSources": { "additionalProperties": {}, "type": "object" }, "proposalArtifactId": { "type": "string" }, "rowNumber": { "format": "int64", "type": "integer" }, "sourceArtifactId": { "type": "string" }, "sourceName": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "validation": { "items": {}, "type": [ "array", "null" ] } }, "required": [ "proposalArtifactId", "status", "updatedAt" ], "type": "object" }, "AgentProductImportWorkbenchSource": { "additionalProperties": false, "properties": { "artifactId": { "type": "string" }, "contentType": { "type": "string" }, "hasPreview": { "description": "True when source image bytes are available for preview.", "type": "boolean" }, "sourceName": { "type": "string" }, "status": { "type": "string" }, "summary": { "type": "string" } }, "required": [ "artifactId", "status" ], "type": "object" }, "AgentProductImportWorkbenchSummary": { "additionalProperties": false, "properties": { "actionableCount": { "description": "Rows needing merchant action (full run; ignores status filter).", "format": "int64", "type": "integer" }, "appliedCount": { "description": "Proposal rows with artifact status applied (full run).", "format": "int64", "type": "integer" }, "applyFailedCount": { "description": "Rows with apply_failed approvals (full run).", "format": "int64", "type": "integer" }, "applyingCount": { "description": "Rows with approvals currently applying (full run).", "format": "int64", "type": "integer" }, "approvedCount": { "description": "Rows with approved but not yet applied approvals (full run).", "format": "int64", "type": "integer" }, "noApprovalCount": { "description": "Proposal rows without a linked approval (full run).", "format": "int64", "type": "integer" }, "pendingApprovalCount": { "description": "Rows with pending approvals (full run).", "format": "int64", "type": "integer" }, "rejectedCount": { "description": "Rows with rejected approvals (full run).", "format": "int64", "type": "integer" }, "reviewableCount": { "description": "Proposal rows still in review (full run).", "format": "int64", "type": "integer" }, "skippedCount": { "description": "Proposal rows marked skipped (full run).", "format": "int64", "type": "integer" } }, "required": [ "noApprovalCount", "pendingApprovalCount", "approvedCount", "applyingCount", "appliedCount", "rejectedCount", "applyFailedCount", "reviewableCount", "skippedCount", "actionableCount" ], "type": "object" }, "AgentProductImportWorkbenchValidation": { "additionalProperties": false, "properties": { "artifactId": { "type": "string" }, "data": { "additionalProperties": {}, "type": "object" }, "sourceName": { "type": "string" }, "status": { "type": "string" } }, "required": [ "artifactId", "status" ], "type": "object" }, "Approval": { "additionalProperties": false, "properties": { "acting_persona": { "type": "string" }, "action": { "type": "string" }, "actor_id": { "type": "string" }, "applied_at": { "format": "date-time", "type": "string" }, "applied_by": { "type": "string" }, "apply_error": { "type": "string" }, "apply_result": { "type": "string" }, "artifact_ids": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "decision_at": { "format": "date-time", "type": "string" }, "decision_by": { "type": "string" }, "id": { "type": "string" }, "idempotency_key": { "type": "string" }, "payload": { "type": "string" }, "request_hash": { "type": "string" }, "risk": { "type": "string" }, "skill_id": { "type": "string" }, "status": { "type": "string" }, "store_id": { "type": "string" }, "summary": { "type": "string" }, "tenant_id": { "type": "string" }, "thread_id": { "type": "string" }, "tool_call_id": { "type": "string" }, "turn_id": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "tenant_id", "risk", "action", "summary", "request_hash", "status", "created_at", "updated_at" ], "type": "object" }, "Artifact": { "additionalProperties": false, "properties": { "content_type": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "skill_id": { "type": "string" }, "skill_run_id": { "type": "string" }, "source_hash": { "type": "string" }, "source_name": { "type": "string" }, "source_uri": { "type": "string" }, "status": { "type": "string" }, "summary": { "type": "string" }, "tenant_id": { "type": "string" }, "thread_id": { "type": "string" }, "turn_id": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "tenant_id", "kind", "status", "created_at", "updated_at" ], "type": "object" }, "AssetUpdateInput": { "additionalProperties": false, "properties": { "expiryHours": { "format": "int64", "type": "integer" }, "maxDownloads": { "format": "int64", "type": "integer" }, "sortOrder": { "format": "int64", "type": "integer" }, "url": { "type": "string" } }, "type": "object" }, "BuyerAssetEntry": { "additionalProperties": false, "properties": { "assetId": { "type": "string" }, "assetType": { "type": "string" }, "deliveryURL": { "type": "string" }, "downloadCount": { "format": "int64", "type": "integer" }, "downloadURL": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "fileName": { "type": "string" }, "fileSize": { "format": "int64", "type": "integer" }, "licenseKeys": { "items": { "$ref": "#/components/schemas/BuyerLicenseEntry" }, "type": [ "array", "null" ] }, "maxDownloads": { "format": "int64", "type": "integer" }, "restrictedReason": { "type": "string" }, "status": { "type": "string" } }, "required": [ "assetId", "assetType", "downloadCount", "maxDownloads", "status" ], "type": "object" }, "BuyerLicenseEntry": { "additionalProperties": false, "properties": { "activations": { "format": "int64", "type": "integer" }, "licenseKey": { "type": "string" }, "licenseType": { "type": "string" }, "maxActivations": { "format": "int64", "type": "integer" } }, "required": [ "licenseKey", "activations" ], "type": "object" }, "CollateralAccountView": { "additionalProperties": false, "properties": { "activatedAt": { "format": "date-time", "type": "string" }, "assetID": { "type": "string" }, "availableAmount": { "type": "string" }, "collateralID": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "fundedAmount": { "type": "string" }, "funding": { "$ref": "#/components/schemas/OperatorFundingStatus" }, "policyID": { "type": "string" }, "policyVersion": { "type": "string" }, "providerID": { "type": "string" }, "requiredAmount": { "type": "string" }, "resourceID": { "type": "string" }, "revision": { "format": "int64", "minimum": 0, "type": "integer" }, "state": { "type": "string" } }, "required": [ "collateralID", "providerID", "resourceID", "assetID", "requiredAmount", "fundedAmount", "availableAmount", "policyID", "policyVersion", "revision", "state", "expiresAt" ], "type": "object" }, "Digital-asset-create-license-keyRequest": { "additionalProperties": false, "properties": { "appId": { "type": "string" }, "listingSlug": { "type": "string" }, "variantSku": { "type": "string" } }, "required": [ "listingSlug" ], "type": "object" }, "Digital-asset-create-linkRequest": { "additionalProperties": false, "properties": { "listingSlug": { "type": "string" }, "url": { "type": "string" }, "variantSku": { "type": "string" } }, "required": [ "listingSlug", "url" ], "type": "object" }, "Digital-asset-import-license-keysRequest": { "additionalProperties": false, "properties": { "appId": { "type": "string" }, "expiresAt": { "description": "RFC3339 expiration timestamp.", "type": "string" }, "keys": { "items": { "type": "string" }, "minItems": 1, "type": [ "array", "null" ] }, "licenseType": { "type": "string" }, "listingSlug": { "type": "string" }, "maxActivations": { "format": "int64", "type": "integer" }, "variantSku": { "type": "string" } }, "required": [ "listingSlug", "keys" ], "type": "object" }, "DigitalAssetInfo": { "additionalProperties": false, "properties": { "assetType": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "expiryHours": { "format": "int64", "type": "integer" }, "fileName": { "type": "string" }, "fileSize": { "format": "int64", "type": "integer" }, "id": { "type": "string" }, "listingSlug": { "type": "string" }, "maxDownloads": { "format": "int64", "type": "integer" }, "mimeType": { "type": "string" }, "sortOrder": { "format": "int64", "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" }, "url": { "type": "string" }, "variantSku": { "type": "string" } }, "required": [ "id", "listingSlug", "assetType", "sortOrder", "maxDownloads", "expiryHours", "createdAt", "updatedAt" ], "type": "object" }, "DigitalDeliveryStatus": { "additionalProperties": false, "properties": { "accessibleGrantCount": { "format": "int64", "type": "integer" }, "assetCount": { "format": "int64", "type": "integer" }, "deliveryURL": { "type": "string" }, "grantCount": { "format": "int64", "type": "integer" }, "isDigitalOrder": { "type": "boolean" }, "listingSlugs": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "manualFallbackAllowed": { "type": "boolean" }, "orderID": { "type": "string" }, "preconfiguredAssetHint": { "type": "boolean" }, "reason": { "type": "string" }, "status": { "type": "string" } }, "required": [ "orderID", "isDigitalOrder", "status", "assetCount", "grantCount", "accessibleGrantCount", "manualFallbackAllowed", "preconfiguredAssetHint" ], "type": "object" }, "EnvelopeError": { "additionalProperties": false, "type": "object" }, "FundingInputBody": { "additionalProperties": false, "properties": { "idempotencyKey": { "maxLength": 192, "minLength": 1, "type": "string" }, "principalDestination": { "maxLength": 512, "minLength": 1, "type": "string" } }, "required": [ "principalDestination", "idempotencyKey" ], "type": "object" }, "FundingTarget": { "additionalProperties": false, "properties": { "amount": { "type": "string" }, "assetID": { "type": "string" }, "collateralID": { "type": "string" }, "destination": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "payload": {}, "railID": { "type": "string" } }, "required": [ "railID", "collateralID", "assetID", "amount", "expiresAt" ], "type": "object" }, "HumaNodePingOutputBody": { "additionalProperties": false, "properties": { "message": { "description": "Static greeting.", "examples": [ "pong" ], "type": "string" }, "serverTime": { "description": "Server time at request handling.", "format": "date-time", "type": "string" } }, "required": [ "message", "serverTime" ], "type": "object" }, "ImportKeysOutputBody": { "additionalProperties": false, "properties": { "imported": { "format": "int64", "type": "integer" } }, "required": [ "imported" ], "type": "object" }, "License-activateRequest": { "additionalProperties": false, "properties": { "fingerprint": { "description": "Unique device/machine fingerprint.", "minLength": 1, "type": "string" }, "label": { "description": "Human-readable device label (e.g. 'MacBook Pro').", "type": "string" }, "licenseKey": { "description": "The license key to activate.", "minLength": 1, "type": "string" } }, "required": [ "licenseKey", "fingerprint" ], "type": "object" }, "License-deactivateRequest": { "additionalProperties": false, "properties": { "fingerprint": { "description": "Device fingerprint to unbind.", "minLength": 1, "type": "string" }, "licenseKey": { "description": "The license key to deactivate.", "minLength": 1, "type": "string" } }, "required": [ "licenseKey", "fingerprint" ], "type": "object" }, "License-validateRequest": { "additionalProperties": false, "properties": { "appID": { "description": "Application identifier for multi-product stores.", "type": "string" }, "fingerprint": { "description": "Optional machine fingerprint for activation check.", "type": "string" }, "licenseKey": { "description": "The license key to validate.", "minLength": 1, "type": "string" } }, "required": [ "licenseKey" ], "type": "object" }, "LicenseActivationResult": { "additionalProperties": false, "properties": { "fingerprint": { "type": "string" }, "id": { "type": "string" }, "isActive": { "type": "boolean" }, "label": { "type": "string" }, "lastSeenAt": { "format": "date-time", "type": "string" }, "licenseId": { "type": "string" } }, "required": [ "id", "licenseId", "fingerprint", "isActive", "lastSeenAt" ], "type": "object" }, "LicenseKeyPoolStats": { "additionalProperties": false, "properties": { "available": { "format": "int64", "type": "integer" }, "dispensed": { "format": "int64", "type": "integer" }, "revoked": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "available", "dispensed", "revoked", "total" ], "type": "object" }, "LicenseValidationResult": { "additionalProperties": false, "properties": { "activations": { "format": "int64", "type": "integer" }, "expiresAt": { "format": "date-time", "type": "string" }, "licenseId": { "type": "string" }, "licenseType": { "type": "string" }, "maxActivations": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "valid": { "type": "boolean" } }, "required": [ "valid" ], "type": "object" }, "MaskedLicenseKey": { "additionalProperties": false, "properties": { "dispensedAt": { "format": "date-time", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "licenseType": { "type": "string" }, "maskedKey": { "type": "string" }, "maxActivations": { "format": "int64", "type": "integer" }, "orderId": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status", "maskedKey", "licenseType", "maxActivations" ], "type": "object" }, "OpenInputBody": { "additionalProperties": false, "properties": { "assetID": { "maxLength": 160, "minLength": 1, "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "idempotencyKey": { "maxLength": 192, "minLength": 1, "type": "string" }, "policyID": { "maxLength": 160, "minLength": 1, "type": "string" }, "policyVersion": { "maxLength": 32, "minLength": 1, "type": "string" }, "providerID": { "maxLength": 160, "minLength": 1, "type": "string" }, "requiredAmount": { "maxLength": 128, "minLength": 1, "type": "string" }, "resourceID": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "providerID", "resourceID", "assetID", "requiredAmount", "policyID", "policyVersion", "idempotencyKey", "expiresAt" ], "type": "object" }, "OperatorFundingStatus": { "additionalProperties": false, "properties": { "amount": { "type": "string" }, "assetID": { "type": "string" }, "attempts": { "format": "int64", "minimum": 0, "type": "integer" }, "destination": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "fundingReference": { "type": "string" }, "lastErrorCode": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "railID": { "type": "string" }, "railVersion": { "type": "string" }, "state": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "railID", "railVersion", "state", "assetID", "amount", "attempts", "expiresAt", "updatedAt" ], "type": "object" }, "SkillRun": { "additionalProperties": false, "properties": { "acting_persona": { "type": "string" }, "actor_id": { "type": "string" }, "completed_at": { "format": "date-time", "type": "string" }, "error": { "type": "string" }, "id": { "type": "string" }, "input": { "type": "string" }, "output": { "type": "string" }, "skill_id": { "type": "string" }, "started_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "store_id": { "type": "string" }, "tenant_id": { "type": "string" }, "thread_id": { "type": "string" }, "turn_id": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "tenant_id", "skill_id", "status", "started_at", "updated_at" ], "type": "object" } }, "securitySchemes": { "adminSession": { "description": "Short-lived HttpOnly standalone administrator session. Unsafe requests also require X-CSRF-Token.", "in": "cookie", "name": "Mobazha_Admin_Session", "type": "apiKey" }, "apiToken": { "bearerFormat": "mbz_\u003cid\u003e_\u003csecret\u003e", "description": "Scoped API token (standalone). Prefix: mbz_.", "scheme": "bearer", "type": "http" }, "basicAuth": { "description": "Standalone admin password via HTTP Basic Auth.", "scheme": "basic", "type": "http" }, "bearerJWT": { "bearerFormat": "JWT", "description": "Casdoor JWT issued by the SaaS platform (Mini App / proxy).", "scheme": "bearer", "type": "http" }, "nodeAuth": { "description": "Node authentication: Basic Auth (standalone admin), Bearer JWT (SaaS proxy), or Bearer mbz_ API token.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "OpenAPI 3.1 contract for the Node business domain (/v1/*). Generated from typed Go handlers via huma v2.", "title": "Mobazha Node API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/v1/admin/password": { "post": { "operationId": "admin-password-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Rotate standalone admin password", "tags": [ "auth" ] } }, "/v1/admin/version": { "get": { "operationId": "admin-version-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Node binary version fingerprint (public)", "tags": [ "system" ] } }, "/v1/agent/approvals": { "get": { "operationId": "agent-approvals-get", "parameters": [ { "description": "Approval status filter: pending, approved, rejected, superseded, applying, applied, apply_failed, or all.", "explode": false, "in": "query", "name": "status", "schema": { "description": "Approval status filter: pending, approved, rejected, superseded, applying, applied, apply_failed, or all.", "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "offset", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List agent approval requests", "tags": [ "ai" ] } }, "/v1/agent/approvals/{approvalId}": { "get": { "operationId": "agent-approval-get", "parameters": [ { "description": "Agent approval ID.", "in": "path", "name": "approvalId", "required": true, "schema": { "description": "Agent approval ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get an agent approval request", "tags": [ "ai" ] } }, "/v1/agent/approvals/{approvalId}/apply": { "post": { "operationId": "agent-approval-apply-post", "parameters": [ { "description": "Agent approval ID.", "in": "path", "name": "approvalId", "required": true, "schema": { "description": "Agent approval ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Apply an approved agent approval request", "tags": [ "ai" ] } }, "/v1/agent/approvals/{approvalId}/decision": { "post": { "operationId": "agent-approval-decision-post", "parameters": [ { "description": "Agent approval ID.", "in": "path", "name": "approvalId", "required": true, "schema": { "description": "Agent approval ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Approve or reject an agent approval request", "tags": [ "ai" ] } }, "/v1/agent/artifacts": { "get": { "operationId": "agent-artifacts-get", "parameters": [ { "explode": false, "in": "query", "name": "skillRunId", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "kind", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "status", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "offset", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List agent artifacts", "tags": [ "ai" ] }, "post": { "operationId": "agent-artifacts-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create an agent artifact", "tags": [ "ai" ] } }, "/v1/agent/artifacts/{artifactId}": { "get": { "operationId": "agent-artifact-get", "parameters": [ { "description": "Agent artifact ID.", "in": "path", "name": "artifactId", "required": true, "schema": { "description": "Agent artifact ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get an agent artifact", "tags": [ "ai" ] }, "patch": { "operationId": "agent-artifact-patch", "parameters": [ { "description": "Agent artifact ID.", "in": "path", "name": "artifactId", "required": true, "schema": { "description": "Agent artifact ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update an agent artifact", "tags": [ "ai" ] } }, "/v1/agent/artifacts/{artifactId}/approval": { "post": { "operationId": "agent-artifact-approval-post", "parameters": [ { "description": "Agent artifact ID.", "in": "path", "name": "artifactId", "required": true, "schema": { "description": "Agent artifact ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create an approval from an agent proposal artifact", "tags": [ "ai" ] } }, "/v1/agent/artifacts/{artifactId}/content": { "get": { "operationId": "agent-artifact-content-get", "parameters": [ { "description": "Agent artifact ID.", "in": "path", "name": "artifactId", "required": true, "schema": { "description": "Agent artifact ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get binary content for an agent source artifact", "tags": [ "ai" ] } }, "/v1/agent/attachments/analyze": { "post": { "operationId": "agent-attachments-analyze-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Analyze a chat attachment on demand", "tags": [ "ai" ] } }, "/v1/agent/chat": { "post": { "description": "Starts a seller AI assistant turn and streams server-sent events. Runtime is handled by a raw chi route so response chunks are not buffered by Huma.", "operationId": "agent-chat-stream-post", "requestBody": { "content": { "application/json": {} }, "description": "Agent chat request body.", "required": true }, "responses": { "200": { "content": { "text/event-stream": {} }, "description": "Server-sent event stream. Events include content, redacted tool progress, done, and error payloads." }, "400": { "description": "Invalid request or AI configuration." }, "429": { "description": "Rate limited or another stream is already active." }, "500": { "description": "Streaming is unavailable." } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Stream an agent chat turn", "tags": [ "ai" ] } }, "/v1/agent/chat/sessions": { "get": { "operationId": "agent-chat-sessions-get", "parameters": [ { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "offset", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List agent chat sessions", "tags": [ "ai" ] } }, "/v1/agent/chat/{sessionId}": { "delete": { "operationId": "agent-chat-session-delete", "parameters": [ { "description": "Chat session ID.", "in": "path", "name": "sessionId", "required": true, "schema": { "description": "Chat session ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete agent chat session", "tags": [ "ai" ] }, "get": { "operationId": "agent-chat-session-get", "parameters": [ { "description": "Chat session ID.", "in": "path", "name": "sessionId", "required": true, "schema": { "description": "Chat session ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get agent chat session", "tags": [ "ai" ] } }, "/v1/agent/memories": { "get": { "operationId": "agent-memories-get", "parameters": [ { "description": "Comma-separated memory scopes: user,store,tenant,thread,skill.", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Comma-separated memory scopes: user,store,tenant,thread,skill.", "type": "string" } }, { "description": "Optional memory subject filter.", "explode": false, "in": "query", "name": "subject", "schema": { "description": "Optional memory subject filter.", "type": "string" } }, { "description": "Optional full-text memory query.", "explode": false, "in": "query", "name": "q", "schema": { "description": "Optional full-text memory query.", "type": "string" } }, { "description": "Maximum number of memories to return.", "explode": false, "in": "query", "name": "limit", "schema": { "description": "Maximum number of memories to return.", "format": "int64", "type": "integer" } }, { "description": "Optional store scope identifier.", "explode": false, "in": "query", "name": "storeId", "schema": { "description": "Optional store scope identifier.", "type": "string" } }, { "description": "Optional thread scope identifier.", "explode": false, "in": "query", "name": "threadId", "schema": { "description": "Optional thread scope identifier.", "type": "string" } }, { "description": "Optional skill scope identifier.", "explode": false, "in": "query", "name": "skillId", "schema": { "description": "Optional skill scope identifier.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "List agent memories", "tags": [ "agent" ] }, "post": { "operationId": "agent-memories-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Save an agent memory", "tags": [ "agent" ] } }, "/v1/agent/memories/{memoryId}": { "delete": { "operationId": "agent-memory-delete", "parameters": [ { "description": "Agent memory ID.", "in": "path", "name": "memoryId", "required": true, "schema": { "description": "Agent memory ID.", "type": "string" } }, { "description": "Optional store scope identifier. When set, it must match the current store.", "explode": false, "in": "query", "name": "storeId", "schema": { "description": "Optional store scope identifier. When set, it must match the current store.", "type": "string" } }, { "description": "Optional thread scope identifier.", "explode": false, "in": "query", "name": "threadId", "schema": { "description": "Optional thread scope identifier.", "type": "string" } }, { "description": "Optional skill scope identifier.", "explode": false, "in": "query", "name": "skillId", "schema": { "description": "Optional skill scope identifier.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Delete an agent memory", "tags": [ "agent" ] }, "patch": { "operationId": "agent-memory-patch", "parameters": [ { "description": "Agent memory ID.", "in": "path", "name": "memoryId", "required": true, "schema": { "description": "Agent memory ID.", "type": "string" } }, { "description": "Optional store scope identifier. When set, it must match the current store.", "explode": false, "in": "query", "name": "storeId", "schema": { "description": "Optional store scope identifier. When set, it must match the current store.", "type": "string" } }, { "description": "Optional thread scope identifier.", "explode": false, "in": "query", "name": "threadId", "schema": { "description": "Optional thread scope identifier.", "type": "string" } }, { "description": "Optional skill scope identifier.", "explode": false, "in": "query", "name": "skillId", "schema": { "description": "Optional skill scope identifier.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Update an agent memory", "tags": [ "agent" ] } }, "/v1/agent/product-import/ingest": { "post": { "operationId": "agent-product-import-ingest-post", "parameters": [ { "in": "header", "name": "Content-Type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Ingest product import source material", "tags": [ "ai" ] } }, "/v1/agent/product-import/runs/{runId}/advance": { "post": { "operationId": "agent-product-import-run-advance-post", "parameters": [ { "description": "Agent skill run ID.", "in": "path", "name": "runId", "required": true, "schema": { "description": "Agent skill run ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProductImportAdvanceRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProductImportAdvanceResult", "description": "Product import run advance result." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Advance a product import run", "tags": [ "ai" ] } }, "/v1/agent/product-import/runs/{runId}/approval-applications": { "post": { "operationId": "agent-product-import-run-approval-applications-post", "parameters": [ { "description": "Agent skill run ID.", "in": "path", "name": "runId", "required": true, "schema": { "description": "Agent skill run ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProductImportApprovalApplyBatchRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProductImportApprovalActionBatchResult", "description": "Batch approval decision or apply result." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Apply approved product import approval requests", "tags": [ "ai" ] } }, "/v1/agent/product-import/runs/{runId}/approval-decisions": { "post": { "operationId": "agent-product-import-run-approval-decisions-post", "parameters": [ { "description": "Agent skill run ID.", "in": "path", "name": "runId", "required": true, "schema": { "description": "Agent skill run ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProductImportApprovalActionBatchRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProductImportApprovalActionBatchResult", "description": "Batch approval decision or apply result." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Approve or reject product import approval requests", "tags": [ "ai" ] } }, "/v1/agent/product-import/runs/{runId}/approvals": { "post": { "operationId": "agent-product-import-run-approvals-post", "parameters": [ { "description": "Agent skill run ID.", "in": "path", "name": "runId", "required": true, "schema": { "description": "Agent skill run ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProductImportApprovalBatchRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create approval requests for product import proposals", "tags": [ "ai" ] } }, "/v1/agent/product-import/runs/{runId}/workbench": { "get": { "operationId": "agent-product-import-workbench-get", "parameters": [ { "description": "Agent skill run ID.", "in": "path", "name": "runId", "required": true, "schema": { "description": "Agent skill run ID.", "type": "string" } }, { "description": "Maximum workbench proposal rows to return.", "explode": false, "in": "query", "name": "limit", "schema": { "description": "Maximum workbench proposal rows to return.", "type": "string" } }, { "description": "Workbench proposal row offset.", "explode": false, "in": "query", "name": "offset", "schema": { "description": "Workbench proposal row offset.", "type": "string" } }, { "description": "Optional row filter. summary counts always reflect the full run; page.totalRows reflects filtered rows.", "explode": false, "in": "query", "name": "status", "schema": { "description": "Optional row filter. summary counts always reflect the full run; page.totalRows reflects filtered rows.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProductImportWorkbench", "description": "Product import workbench for a skill run." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get product import workbench data", "tags": [ "ai" ] } }, "/v1/agent/skill-runs": { "get": { "operationId": "agent-skill-runs-get", "parameters": [ { "explode": false, "in": "query", "name": "skillId", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "status", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "offset", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List agent skill runs", "tags": [ "ai" ] }, "post": { "operationId": "agent-skill-runs-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create an agent skill run", "tags": [ "ai" ] } }, "/v1/agent/skill-runs/{runId}": { "get": { "operationId": "agent-skill-run-get", "parameters": [ { "description": "Agent skill run ID.", "in": "path", "name": "runId", "required": true, "schema": { "description": "Agent skill run ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get an agent skill run", "tags": [ "ai" ] }, "patch": { "operationId": "agent-skill-run-patch", "parameters": [ { "description": "Agent skill run ID.", "in": "path", "name": "runId", "required": true, "schema": { "description": "Agent skill run ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update an agent skill run", "tags": [ "ai" ] } }, "/v1/ai/generate": { "post": { "operationId": "ai-generate-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Generate AI content", "tags": [ "ai" ] } }, "/v1/ai/status": { "get": { "operationId": "ai-status-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "AI availability and quota status", "tags": [ "ai" ] } }, "/v1/analytics/stats": { "get": { "operationId": "analytics-get-stats", "parameters": [ { "explode": false, "in": "query", "name": "days", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Authenticated seller analytics rollup", "tags": [ "analytics" ] } }, "/v1/analytics/{peerID}/events": { "post": { "operationId": "analytics-shop-post-events-public", "parameters": [ { "description": "Peer scope baked into storefront URL.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Peer scope baked into storefront URL.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Fan-in analytics events without auth", "tags": [ "analytics" ] } }, "/v1/auth/admin-session": { "delete": { "operationId": "auth-admin-session-delete", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminSessionStatus" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "Set-Cookie": { "schema": { "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Revoke the current standalone administrator session", "tags": [ "auth" ] }, "get": { "operationId": "auth-admin-session-get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminSessionStatus" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "Set-Cookie": { "schema": { "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Inspect the current standalone administrator session", "tags": [ "auth" ] }, "post": { "operationId": "auth-admin-session-post", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminSessionStatus" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "Set-Cookie": { "schema": { "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] } ], "summary": "Create a short-lived standalone administrator session", "tags": [ "auth" ] } }, "/v1/auth/identity": { "get": { "operationId": "auth-identity-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Inspect resolved principal and scopes", "tags": [ "auth" ] } }, "/v1/auth/scopes": { "get": { "operationId": "auth-scopes-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Enumerate token scope catalog", "tags": [ "auth" ] } }, "/v1/auth/tokens": { "get": { "operationId": "auth-tokens-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "List local API tokens (standalone)", "tags": [ "auth" ] }, "post": { "operationId": "auth-tokens-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Mint local API token (standalone)", "tags": [ "auth" ] } }, "/v1/auth/tokens/{tokenID}": { "delete": { "operationId": "auth-tokens-token-id-delete", "parameters": [ { "in": "path", "name": "tokenID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Revoke local API token by ID", "tags": [ "auth" ] } }, "/v1/blocklist/{peerID}": { "delete": { "operationId": "blocklist-peer-id-delete", "parameters": [ { "in": "path", "name": "peerID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Remove blocklist entry", "tags": [ "moderation" ] }, "put": { "operationId": "blocklist-peer-id-put", "parameters": [ { "in": "path", "name": "peerID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Block storefront peer IDs", "tags": [ "moderation" ] } }, "/v1/carts": { "delete": { "operationId": "carts-delete-all", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Clear all carts", "tags": [ "carts" ] }, "get": { "operationId": "carts-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List shopping carts", "tags": [ "carts" ] } }, "/v1/carts/count": { "get": { "operationId": "carts-get-items-count", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Cart item count across vendors", "tags": [ "carts" ] } }, "/v1/carts/{peerID}/items": { "delete": { "operationId": "carts-delete-peer-items", "parameters": [ { "description": "Vendor peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Vendor peer ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Remove item from cart", "tags": [ "carts" ] }, "post": { "operationId": "carts-post-peer-items", "parameters": [ { "description": "Vendor peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Vendor peer ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Add item to cart for vendor", "tags": [ "carts" ] }, "put": { "operationId": "carts-put-peer-items", "parameters": [ { "description": "Vendor peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Vendor peer ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update cart item for vendor", "tags": [ "carts" ] } }, "/v1/cases": { "get": { "operationId": "cases-get-query", "parameters": [ { "explode": false, "in": "query", "name": "state", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "search", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List dispute cases", "tags": [ "orders", "cases" ] }, "post": { "operationId": "cases-post-query", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List dispute cases via JSON filter", "tags": [ "orders", "cases" ] } }, "/v1/cases/{orderID}": { "get": { "operationId": "cases-get-detail", "parameters": [ { "description": "Underlying order ID for case.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Underlying order ID for case.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Retrieve dispute case envelope", "tags": [ "cases" ] } }, "/v1/chat/blocked-users": { "get": { "operationId": "chat-list-blocked-users", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List blocked chat users", "tags": [ "chat" ] } }, "/v1/chat/invites": { "get": { "operationId": "chat-list-invites", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List pending chat invites", "tags": [ "chat" ] } }, "/v1/chat/media/upload": { "post": { "operationId": "chat-media-upload", "parameters": [ { "in": "header", "name": "Content-Type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Upload chat media (multipart)", "tags": [ "chat" ] } }, "/v1/chat/media/{serverName}/{mediaID}": { "get": { "operationId": "chat-media-download", "parameters": [ { "description": "Matrix server name.", "in": "path", "name": "serverName", "required": true, "schema": { "description": "Matrix server name.", "type": "string" } }, { "description": "Matrix media ID.", "in": "path", "name": "mediaID", "required": true, "schema": { "description": "Matrix media ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Download chat media", "tags": [ "chat" ] } }, "/v1/chat/presence": { "get": { "operationId": "chat-get-presence", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get chat presence status", "tags": [ "chat" ] }, "post": { "operationId": "chat-set-presence", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Set chat presence status", "tags": [ "chat" ] } }, "/v1/chat/rooms": { "get": { "operationId": "chat-list-rooms", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List chat rooms", "tags": [ "chat" ] }, "post": { "operationId": "chat-create-room", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create a new chat room", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/avatar": { "post": { "operationId": "chat-set-room-avatar", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } }, { "in": "header", "name": "Content-Type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Set chat room avatar (multipart)", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/invite": { "post": { "operationId": "chat-invite-member", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Invite a user to a chat room", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/join": { "post": { "operationId": "chat-join-room", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Join a chat room", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/kick": { "post": { "operationId": "chat-kick-member", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Kick a user from a chat room", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/leave": { "post": { "operationId": "chat-leave-room", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Leave a chat room", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/members": { "get": { "operationId": "chat-get-members", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List room members", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/messages": { "get": { "operationId": "chat-get-messages", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } }, { "description": "Max messages to return.", "explode": false, "in": "query", "name": "limit", "schema": { "description": "Max messages to return.", "type": "string" } }, { "description": "Pagination cursor: events before this token.", "explode": false, "in": "query", "name": "before", "schema": { "description": "Pagination cursor: events before this token.", "type": "string" } }, { "description": "Pagination cursor: events after this token.", "explode": false, "in": "query", "name": "after", "schema": { "description": "Pagination cursor: events after this token.", "type": "string" } }, { "description": "Sync-style incremental cursor.", "explode": false, "in": "query", "name": "since", "schema": { "description": "Sync-style incremental cursor.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get messages in a chat room", "tags": [ "chat" ] }, "post": { "operationId": "chat-send-message", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Send a message in a chat room", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/messages/{eventID}": { "delete": { "operationId": "chat-delete-message", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } }, { "description": "Matrix event ID.", "in": "path", "name": "eventID", "required": true, "schema": { "description": "Matrix event ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete a chat message", "tags": [ "chat" ] }, "put": { "operationId": "chat-edit-message", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } }, { "description": "Matrix event ID.", "in": "path", "name": "eventID", "required": true, "schema": { "description": "Matrix event ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Edit a chat message", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/messages/{eventID}/reactions": { "post": { "operationId": "chat-react-message", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } }, { "description": "Matrix event ID.", "in": "path", "name": "eventID", "required": true, "schema": { "description": "Matrix event ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "React to a chat message", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/read": { "post": { "operationId": "chat-mark-read", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Mark room messages as read", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/settings": { "get": { "operationId": "chat-get-room-settings", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get chat room settings", "tags": [ "chat" ] }, "put": { "operationId": "chat-put-room-settings", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update chat room settings", "tags": [ "chat" ] } }, "/v1/chat/rooms/{roomID}/typing": { "post": { "operationId": "chat-typing", "parameters": [ { "description": "Matrix room ID.", "in": "path", "name": "roomID", "required": true, "schema": { "description": "Matrix room ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Send typing indicator", "tags": [ "chat" ] } }, "/v1/chat/settings": { "get": { "operationId": "chat-get-settings", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get global chat settings", "tags": [ "chat" ] }, "put": { "operationId": "chat-put-settings", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update global chat settings", "tags": [ "chat" ] } }, "/v1/chat/status": { "get": { "operationId": "chat-get-status", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get Matrix chat connection status", "tags": [ "chat" ] } }, "/v1/chat/users/{userID}/block": { "delete": { "operationId": "chat-unblock-user", "parameters": [ { "description": "Matrix user ID.", "in": "path", "name": "userID", "required": true, "schema": { "description": "Matrix user ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Unblock a chat user", "tags": [ "chat" ] }, "post": { "operationId": "chat-block-user", "parameters": [ { "description": "Matrix user ID.", "in": "path", "name": "userID", "required": true, "schema": { "description": "Matrix user ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Block a chat user", "tags": [ "chat" ] } }, "/v1/chat/verification/request": { "post": { "operationId": "chat-verification-request", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Request device verification", "tags": [ "chat" ] } }, "/v1/chat/verification/{txnId}/accept": { "post": { "operationId": "chat-verification-accept", "parameters": [ { "description": "Verification transaction ID.", "in": "path", "name": "txnId", "required": true, "schema": { "description": "Verification transaction ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Accept verification request", "tags": [ "chat" ] } }, "/v1/chat/verification/{txnId}/cancel": { "post": { "operationId": "chat-verification-cancel", "parameters": [ { "description": "Verification transaction ID.", "in": "path", "name": "txnId", "required": true, "schema": { "description": "Verification transaction ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Cancel verification", "tags": [ "chat" ] } }, "/v1/chat/verification/{txnId}/confirm": { "post": { "operationId": "chat-verification-confirm", "parameters": [ { "description": "Verification transaction ID.", "in": "path", "name": "txnId", "required": true, "schema": { "description": "Verification transaction ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Confirm SAS verification", "tags": [ "chat" ] } }, "/v1/chat/verification/{txnId}/start-sas": { "post": { "operationId": "chat-verification-start-sas", "parameters": [ { "description": "Verification transaction ID.", "in": "path", "name": "txnId", "required": true, "schema": { "description": "Verification transaction ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Start SAS verification", "tags": [ "chat" ] } }, "/v1/collateral/accounts": { "post": { "description": "Creates or retrieves one tenant- and local-principal-bound collateral requirement. This does not prove funding.", "operationId": "collateral-accounts-open", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenInputBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralAccountView" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Open a collateral account", "tags": [ "collateral" ] } }, "/v1/collateral/accounts/{collateralID}": { "get": { "description": "Returns a safe tenant-local account and funding projection without credentials, evidence, raw rail payload, or idempotency identity.", "operationId": "collateral-accounts-get", "parameters": [ { "in": "path", "name": "collateralID", "required": true, "schema": { "maxLength": 96, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralAccountView" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Get collateral account status", "tags": [ "collateral" ] } }, "/v1/collateral/accounts/{collateralID}/funding-target": { "post": { "description": "Creates or retrieves a persisted funding target through the configured reviewed rail. The target is not funding proof.", "operationId": "collateral-funding-target-prepare", "parameters": [ { "in": "path", "name": "collateralID", "required": true, "schema": { "maxLength": 96, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingInputBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingTarget" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Prepare a collateral funding target", "tags": [ "collateral" ] } }, "/v1/collateral/accounts/{collateralID}/funding/reconcile": { "post": { "description": "Polls the configured rail and applies only receipt-verified confirmed funding to the Core aggregate.", "operationId": "collateral-funding-reconcile", "parameters": [ { "in": "path", "name": "collateralID", "required": true, "schema": { "maxLength": 96, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralAccountView" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Reconcile collateral funding", "tags": [ "collateral" ] } }, "/v1/collections": { "get": { "operationId": "collections-get", "parameters": [ { "explode": false, "in": "query", "name": "page", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "pageSize", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "publishedOnly", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List collections", "tags": [ "collections" ] }, "post": { "operationId": "collections-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create collection", "tags": [ "collections" ] } }, "/v1/collections/{collectionID}": { "delete": { "operationId": "collections-id-delete", "parameters": [ { "description": "Collection ID.", "in": "path", "name": "collectionID", "required": true, "schema": { "description": "Collection ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete collection", "tags": [ "collections" ] }, "get": { "operationId": "collections-id-get", "parameters": [ { "description": "Collection ID.", "in": "path", "name": "collectionID", "required": true, "schema": { "description": "Collection ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get collection", "tags": [ "collections" ] }, "put": { "operationId": "collections-id-put", "parameters": [ { "in": "path", "name": "collectionID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update collection", "tags": [ "collections" ] } }, "/v1/collections/{collectionID}/products": { "post": { "operationId": "collections-id-products-post", "parameters": [ { "in": "path", "name": "collectionID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Add products to collection", "tags": [ "collections" ] } }, "/v1/collections/{collectionID}/products/reorder": { "put": { "operationId": "collections-id-products-reorder-put", "parameters": [ { "in": "path", "name": "collectionID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Reorder products in collection", "tags": [ "collections" ] } }, "/v1/collections/{collectionID}/products/{slug}": { "delete": { "operationId": "collections-id-products-slug-delete", "parameters": [ { "in": "path", "name": "collectionID", "required": true, "schema": { "type": "string" } }, { "description": "Listing slug.", "in": "path", "name": "slug", "required": true, "schema": { "description": "Listing slug.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Remove product from collection", "tags": [ "collections" ] } }, "/v1/collections/{peerID}/published": { "get": { "operationId": "collections-peer-published-get", "parameters": [ { "description": "Store peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Store peer ID.", "type": "string" } }, { "explode": false, "in": "query", "name": "page", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "pageSize", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "List published collections (public storefront)", "tags": [ "collections" ] } }, "/v1/collections/{peerID}/published/{collectionID}": { "get": { "operationId": "collections-peer-published-id-get", "parameters": [ { "in": "path", "name": "peerID", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "collectionID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get published collection (public storefront)", "tags": [ "collections" ] } }, "/v1/config": { "get": { "operationId": "config-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get gateway configuration snapshot", "tags": [ "system" ] } }, "/v1/crypto/hash": { "post": { "operationId": "crypto-hash-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Stable hash helper for payloads", "tags": [ "crypto" ] } }, "/v1/crypto/sign": { "post": { "operationId": "crypto-sign-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Sign a payload with seller keys", "tags": [ "crypto" ] } }, "/v1/crypto/verify": { "post": { "operationId": "crypto-verify-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Verify a detached signature", "tags": [ "crypto" ] } }, "/v1/digital-assets": { "get": { "operationId": "digital-asset-list", "parameters": [ { "explode": false, "in": "query", "name": "listingSlug", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "variantSku", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DigitalAssetInfo" }, "type": [ "array", "null" ] } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List digital assets for a listing", "tags": [ "digital-assets" ] } }, "/v1/digital-assets/license-key": { "post": { "operationId": "digital-asset-create-license-key", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digital-asset-create-license-keyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalAssetInfo" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create a license-key-type digital asset", "tags": [ "digital-assets" ] } }, "/v1/digital-assets/license-keys": { "get": { "operationId": "digital-asset-list-license-keys", "parameters": [ { "explode": false, "in": "query", "name": "listingSlug", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "variantSku", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int64", "maximum": 200, "minimum": 1, "type": "integer" } }, { "explode": false, "in": "query", "name": "offset", "schema": { "default": 0, "format": "int64", "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MaskedLicenseKey" }, "type": [ "array", "null" ] } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List license keys (masked) for a listing", "tags": [ "digital-assets" ] }, "post": { "operationId": "digital-asset-import-license-keys", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digital-asset-import-license-keysRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportKeysOutputBody" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Import license keys for a listing", "tags": [ "digital-assets" ] } }, "/v1/digital-assets/license-keys/stats": { "get": { "operationId": "digital-asset-license-key-stats", "parameters": [ { "explode": false, "in": "query", "name": "listingSlug", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "variantSku", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseKeyPoolStats" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get license key pool statistics for a listing", "tags": [ "digital-assets" ] } }, "/v1/digital-assets/license-keys/{keyID}/revoke": { "post": { "operationId": "digital-asset-revoke-license-key", "parameters": [ { "in": "path", "name": "keyID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Revoke a license key", "tags": [ "digital-assets" ] } }, "/v1/digital-assets/link": { "post": { "operationId": "digital-asset-create-link", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digital-asset-create-linkRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalAssetInfo" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create a link-type digital asset", "tags": [ "digital-assets" ] } }, "/v1/digital-assets/{assetID}": { "delete": { "operationId": "digital-asset-delete", "parameters": [ { "in": "path", "name": "assetID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete a digital asset", "tags": [ "digital-assets" ] }, "get": { "operationId": "digital-asset-get", "parameters": [ { "in": "path", "name": "assetID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalAssetInfo" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get a digital asset by ID", "tags": [ "digital-assets" ] }, "patch": { "operationId": "digital-asset-update", "parameters": [ { "in": "path", "name": "assetID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetUpdateInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalAssetInfo" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update a digital asset", "tags": [ "digital-assets" ] } }, "/v1/discounts": { "get": { "operationId": "discounts-get", "parameters": [ { "explode": false, "in": "query", "name": "page", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "pageSize", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "status", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "method", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "q", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List discounts", "tags": [ "discounts" ] }, "post": { "operationId": "discounts-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "Created" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create discount", "tags": [ "discounts" ] } }, "/v1/discounts/{discountID}": { "delete": { "operationId": "discounts-id-delete", "parameters": [ { "description": "Discount ID.", "in": "path", "name": "discountID", "required": true, "schema": { "description": "Discount ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete discount", "tags": [ "discounts" ] }, "get": { "operationId": "discounts-id-get", "parameters": [ { "description": "Discount ID.", "in": "path", "name": "discountID", "required": true, "schema": { "description": "Discount ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get discount", "tags": [ "discounts" ] }, "put": { "operationId": "discounts-id-put", "parameters": [ { "in": "path", "name": "discountID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update discount", "tags": [ "discounts" ] } }, "/v1/discounts/{discountID}/codes": { "get": { "operationId": "discounts-id-codes-get", "parameters": [ { "description": "Discount ID.", "in": "path", "name": "discountID", "required": true, "schema": { "description": "Discount ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List discount codes", "tags": [ "discounts" ] }, "post": { "operationId": "discounts-id-codes-post", "parameters": [ { "in": "path", "name": "discountID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "Created" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Add discount codes", "tags": [ "discounts" ] } }, "/v1/discounts/{discountID}/codes/{codeID}": { "delete": { "operationId": "discounts-id-codes-code-delete", "parameters": [ { "in": "path", "name": "discountID", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete a discount code", "tags": [ "discounts" ] } }, "/v1/discounts/{discountID}/redemptions": { "get": { "operationId": "discounts-id-redemptions-get", "parameters": [ { "in": "path", "name": "discountID", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "page", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "pageSize", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List discount redemptions", "tags": [ "discounts" ] } }, "/v1/discounts/{peerID}/applicable": { "get": { "operationId": "discounts-applicable", "parameters": [ { "in": "path", "name": "peerID", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "listingSlug", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get applicable discounts (public)", "tags": [ "discounts" ] } }, "/v1/discounts/{peerID}/calculate": { "post": { "operationId": "discounts-calculate", "parameters": [ { "in": "path", "name": "peerID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Calculate discount amounts (public)", "tags": [ "discounts" ] } }, "/v1/discounts/{peerID}/validate": { "post": { "operationId": "discounts-validate", "parameters": [ { "in": "path", "name": "peerID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Validate a discount code (public)", "tags": [ "discounts" ] } }, "/v1/disputes/{orderID}/after-sale": { "post": { "operationId": "disputes-post-after-sale", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Open an after-sale dispute", "tags": [ "disputes" ] } }, "/v1/disputes/{orderID}/close": { "post": { "operationId": "disputes-post-close", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Close a dispute", "tags": [ "disputes" ] } }, "/v1/disputes/{orderID}/instructions/release": { "post": { "description": "Compatibility endpoint for client-signed moderated dispute payouts. backend-managed moderated dispute resolution stays on the backend close/release path and should not use this instructions contract as its primary entrypoint.", "operationId": "disputes-post-instructions-release", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Legacy dispute release instructions", "tags": [ "disputes" ] } }, "/v1/disputes/{orderID}/open": { "post": { "operationId": "disputes-post-open", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Open a dispute", "tags": [ "disputes" ] } }, "/v1/disputes/{orderID}/release": { "post": { "operationId": "disputes-post-release", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Release escrow funds", "tags": [ "disputes" ] } }, "/v1/disputes/{orderID}/release-after-timeout": { "post": { "operationId": "disputes-post-release-after-timeout", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Release escrow after timeout", "tags": [ "disputes" ] } }, "/v1/exchange-rates": { "get": { "operationId": "exchange-rates-get", "parameters": [ { "explode": false, "in": "query", "name": "refresh", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Retrieve FX matrix for reserve currency baseline", "tags": [ "wallet" ] } }, "/v1/exchange-rates/{currencyCode}": { "get": { "operationId": "exchange-rates-currency-code-get", "parameters": [ { "in": "path", "name": "currencyCode", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Retrieve FX matrix for denominated currency", "tags": [ "wallet" ] } }, "/v1/features": { "get": { "operationId": "features-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get feature flags", "tags": [ "settings" ] } }, "/v1/fiat/provider-actions": { "get": { "operationId": "fiat-list-provider-actions", "parameters": [ { "description": "Optional fiat provider filter.", "explode": false, "in": "query", "name": "provider", "schema": { "description": "Optional fiat provider filter.", "type": "string" } }, { "description": "Optional action-kind filter.", "explode": false, "in": "query", "name": "action", "schema": { "description": "Optional action-kind filter.", "type": "string" } }, { "description": "Optional durable state filter.", "explode": false, "in": "query", "name": "state", "schema": { "description": "Optional durable state filter.", "type": "string" } }, { "description": "Maximum rows; zero uses the server default.", "explode": false, "in": "query", "name": "limit", "schema": { "description": "Maximum rows; zero uses the server default.", "format": "int64", "maximum": 100, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List durable fiat provider actions", "tags": [ "fiat" ] } }, "/v1/fiat/provider-actions/{actionID}/retry": { "post": { "operationId": "fiat-retry-provider-action", "parameters": [ { "description": "Durable provider action ID.", "in": "path", "name": "actionID", "required": true, "schema": { "description": "Durable provider action ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Retry a durable fiat provider action", "tags": [ "fiat" ] } }, "/v1/fiat/providers": { "get": { "operationId": "fiat-list-enabled-providers", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List enabled fiat providers for seller dashboard", "tags": [ "fiat" ] } }, "/v1/fiat/{peerID}/providers": { "get": { "operationId": "fiat-public-list-providers-by-peer", "parameters": [ { "description": "Seller peer scope.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Seller peer scope.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Browse enabled fiat providers for a storefront peer", "tags": [ "fiat" ] } }, "/v1/fiat/{peerID}/{providerID}/payments": { "post": { "operationId": "fiat-public-create-checkout-session", "parameters": [ { "description": "Seller peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Seller peer ID.", "type": "string" } }, { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Create checkout session scoped to storefront peer", "tags": [ "fiat" ] } }, "/v1/fiat/{peerID}/{providerID}/payments/{sessionID}/capture": { "post": { "operationId": "fiat-public-capture-checkout-session", "parameters": [ { "description": "Seller peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Seller peer ID.", "type": "string" } }, { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } }, { "description": "Session ID to capture.", "in": "path", "name": "sessionID", "required": true, "schema": { "description": "Session ID to capture.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Capture an authorized fiat session via storefront routing", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/config": { "delete": { "operationId": "fiat-disconnect-provider", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Disconnect a fiat provider", "tags": [ "fiat" ] }, "get": { "operationId": "fiat-get-provider-config-view", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Load seller-facing provider configuration", "tags": [ "fiat" ] }, "put": { "operationId": "fiat-save-provider-config", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Save fiat provider keys and settings", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/payments": { "post": { "operationId": "fiat-create-payment-session", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create a fiat checkout session", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/payments/{paymentID}": { "get": { "operationId": "fiat-get-payment", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } }, { "description": "Provider payment/session ID.", "in": "path", "name": "paymentID", "required": true, "schema": { "description": "Provider payment/session ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get fiat payment details", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/payments/{paymentID}/refund": { "post": { "operationId": "fiat-refund-payment", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } }, { "description": "Payment ID to refund.", "in": "path", "name": "paymentID", "required": true, "schema": { "description": "Payment ID to refund.", "type": "string" } }, { "description": "Stable key for this refund intent.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "description": "Stable key for this refund intent.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Refund a fiat payment", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/payments/{sessionID}/capture": { "post": { "operationId": "fiat-capture-payment", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } }, { "description": "Authorized session ID to capture.", "in": "path", "name": "sessionID", "required": true, "schema": { "description": "Authorized session ID to capture.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Capture a fiat authorization", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/setup-webhook": { "post": { "operationId": "fiat-register-provider-webhook", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Automatically register provider webhook URLs", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/status": { "get": { "operationId": "fiat-get-provider-connection-status", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Seller fiat provider onboarding status", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/verify": { "post": { "operationId": "fiat-verify-provider-credentials", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Ping provider credentials", "tags": [ "fiat" ] } }, "/v1/fiat/{providerID}/webhooks": { "post": { "operationId": "fiat-public-ingest-provider-webhook", "parameters": [ { "description": "Fiat provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fiat provider ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Inbound provider webhook relay", "tags": [ "fiat" ] } }, "/v1/followers": { "get": { "operationId": "followers-list-self", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Follower list scoped to implicit peer", "tags": [ "followers" ] } }, "/v1/followers/{peerID}": { "get": { "operationId": "followers-list-by-peer-id", "parameters": [ { "description": "Peer whose followers should be listed.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Peer whose followers should be listed.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Public follower list", "tags": [ "followers" ] } }, "/v1/followers/{peerID}/check": { "get": { "operationId": "followers-check-follows-me", "parameters": [ { "description": "Peer ID whose follow relationship is checked.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Peer ID whose follow relationship is checked.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Whether the caller is followed by the given peer", "tags": [ "followers" ] } }, "/v1/following": { "get": { "operationId": "following-list-self", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Following list scoped to implicit peer", "tags": [ "following" ] } }, "/v1/following/{peerID}": { "delete": { "operationId": "following-unfollow-peer", "parameters": [ { "description": "Peer ID to unfollow.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Peer ID to unfollow.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Stop following a peer", "tags": [ "following" ] }, "get": { "operationId": "following-list-by-peer-id", "parameters": [ { "description": "Peer whose following entries are listed.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Peer whose following entries are listed.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Accounts a peer follows", "tags": [ "following" ] }, "put": { "operationId": "following-follow-peer", "parameters": [ { "description": "Peer ID to follow.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Peer ID to follow.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Follow a peer", "tags": [ "following" ] } }, "/v1/fulfillment/alerts": { "get": { "operationId": "fulfillment-get-alerts", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List fulfillment alerts", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/alerts/{alertID}": { "delete": { "operationId": "fulfillment-delete-alert", "parameters": [ { "description": "Alert ID to dismiss.", "in": "path", "name": "alertID", "required": true, "schema": { "description": "Alert ID to dismiss.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Dismiss a fulfillment alert", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/locations": { "get": { "operationId": "fulfillment-get-locations", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List fulfillment locations", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/locations/{locationID}": { "get": { "operationId": "fulfillment-get-location", "parameters": [ { "description": "Fulfillment location ID.", "in": "path", "name": "locationID", "required": true, "schema": { "description": "Fulfillment location ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get fulfillment location detail", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/orders/{orderID}/status": { "get": { "operationId": "fulfillment-get-order-status", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get fulfillment execution status", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/products/{slug}/sync": { "post": { "operationId": "fulfillment-post-sync-product-by-slug", "parameters": [ { "description": "Listing slug to sync.", "in": "path", "name": "slug", "required": true, "schema": { "description": "Listing slug to sync.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Push sync updates for a product by slug", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/providers": { "get": { "operationId": "fulfillment-list-providers", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List fulfillment providers", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/rules": { "get": { "operationId": "fulfillment-get-rules", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List fulfillment auto-action rules", "tags": [ "fulfillment" ] }, "post": { "operationId": "fulfillment-post-rule", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create a fulfillment auto-action rule", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/rules/{ruleID}": { "delete": { "operationId": "fulfillment-delete-rule", "parameters": [ { "description": "Rule ID to delete.", "in": "path", "name": "ruleID", "required": true, "schema": { "description": "Rule ID to delete.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete a fulfillment auto-action rule", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/catalog": { "get": { "operationId": "fulfillment-get-catalog", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } }, { "explode": false, "in": "query", "name": "categoryId", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "search", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "offset", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Browse provider catalog", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/catalog/{productID}": { "get": { "operationId": "fulfillment-get-catalog-product", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } }, { "description": "Catalog product ID.", "in": "path", "name": "productID", "required": true, "schema": { "description": "Catalog product ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get catalog product detail", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/connect": { "post": { "operationId": "fulfillment-post-connect", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Connect a fulfillment provider", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/disconnect": { "delete": { "operationId": "fulfillment-delete-disconnect", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Disconnect fulfillment provider", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/import": { "post": { "operationId": "fulfillment-post-import-product", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Import a product from provider catalog", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/shipping-estimates": { "post": { "operationId": "fulfillment-post-shipping-estimates", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Estimate shipping via provider", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/status": { "get": { "operationId": "fulfillment-get-provider-status", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Fulfillment provider connection status", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/store-products": { "get": { "operationId": "fulfillment-get-store-sync-products", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } }, { "explode": false, "in": "query", "name": "offset", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Browse store sync products", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/store-products/{syncProductID}": { "get": { "operationId": "fulfillment-get-store-sync-product", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } }, { "description": "Store sync product ID.", "in": "path", "name": "syncProductID", "required": true, "schema": { "description": "Store sync product ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get a store sync product", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/synced-products": { "get": { "operationId": "fulfillment-get-synced-products", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List synced fulfillment products", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/synced-products/{mappingID}": { "delete": { "operationId": "fulfillment-delete-synced-product", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } }, { "description": "Synced product mapping ID.", "in": "path", "name": "mappingID", "required": true, "schema": { "description": "Synced product mapping ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Unlink a synced product from its supplier", "tags": [ "fulfillment" ] } }, "/v1/fulfillment/{providerID}/webhooks/{webhookSecret}": { "post": { "operationId": "fulfillment-public-post-provider-webhook", "parameters": [ { "description": "Fulfillment provider ID.", "in": "path", "name": "providerID", "required": true, "schema": { "description": "Fulfillment provider ID.", "type": "string" } }, { "description": "Webhook secret path segment.", "in": "path", "name": "webhookSecret", "required": true, "schema": { "description": "Webhook secret path segment.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Provider fulfillment webhook receiver", "tags": [ "fulfillment" ] } }, "/v1/guest/orders": { "get": { "operationId": "guest-orders-list-auth", "parameters": [ { "explode": false, "in": "query", "name": "state", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "page", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "pageSize", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Seller-visible guest-checkout orders", "tags": [ "orders", "guest" ] }, "post": { "operationId": "guest-orders-post-public", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "Created" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Public guest checkout initiation", "tags": [ "orders", "guest" ] } }, "/v1/guest/orders/quote": { "post": { "operationId": "guest-orders-quote-public", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Public guest checkout supply preflight", "tags": [ "orders", "guest" ] } }, "/v1/guest/orders/{token}": { "get": { "operationId": "guest-orders-get-public", "parameters": [ { "description": "Guest checkout token.", "in": "path", "name": "token", "required": true, "schema": { "description": "Guest checkout token.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Public guest order tracker", "tags": [ "orders", "guest" ] } }, "/v1/guest/orders/{token}/complete": { "put": { "operationId": "guest-orders-complete-token", "parameters": [ { "description": "Guest checkout token.", "in": "path", "name": "token", "required": true, "schema": { "description": "Guest checkout token.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Manually finalize guest-funded order", "tags": [ "orders", "guest" ] } }, "/v1/guest/orders/{token}/detail": { "get": { "operationId": "guest-orders-admin-detail", "parameters": [ { "description": "Guest checkout token.", "in": "path", "name": "token", "required": true, "schema": { "description": "Guest checkout token.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Admin: full guest order detail including encrypted shipping address", "tags": [ "orders", "guest" ] } }, "/v1/guest/orders/{token}/ship": { "put": { "operationId": "guest-orders-ship-token", "parameters": [ { "description": "Guest checkout token.", "in": "path", "name": "token", "required": true, "schema": { "description": "Guest checkout token.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Mark guest order shipped with tracking payload", "tags": [ "orders", "guest" ] } }, "/v1/listings": { "post": { "operationId": "listings-create", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create listing", "tags": [ "listings" ] }, "put": { "operationId": "listings-update", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update listing", "tags": [ "listings" ] } }, "/v1/listings/import": { "post": { "operationId": "listing-import-multipart", "parameters": [ { "in": "header", "name": "Content-Type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Import listings from ZIP (multipart)", "tags": [ "listings" ] } }, "/v1/listings/import/gumroad": { "post": { "description": "Reads products from the Gumroad v2 API using a personal access token and imports them as DRAFT digital-good listings. The seller must upload the actual digital file to each draft before publishing — Gumroad's protected file URLs are not server-fetchable. Pass {\"dryRun\": true} to preview without writing.", "operationId": "listings-import-gumroad", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Import listings from a Gumroad creator account", "tags": [ "listings" ] } }, "/v1/listings/import/json": { "post": { "operationId": "listings-import-json", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Batch import listings from JSON payload", "tags": [ "listings" ] } }, "/v1/listings/index": { "get": { "operationId": "listings-index", "parameters": [ { "description": "Include seller-safe supply summaries for the authenticated store owner.", "explode": false, "in": "query", "name": "includeSupplySummary", "schema": { "description": "Include seller-safe supply summaries for the authenticated store owner.", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get listing index (self)", "tags": [ "listings" ] } }, "/v1/listings/index/{peerID}": { "get": { "operationId": "listings-index-by-peer-id", "parameters": [ { "description": "Seller peer ID for listing index.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Seller peer ID for listing index.", "type": "string" } }, { "description": "Return cached listing index when true.", "explode": false, "in": "query", "name": "usecache", "schema": { "description": "Return cached listing index when true.", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get listing index for a peer", "tags": [ "listings" ] } }, "/v1/listings/mine/{slugOrCID}": { "get": { "operationId": "listings-get-mine-slug-or-cid", "parameters": [ { "description": "Seller listing slug or CID.", "in": "path", "name": "slugOrCID", "required": true, "schema": { "description": "Seller listing slug or CID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get authenticated seller listing by slug or CID", "tags": [ "listings" ] } }, "/v1/listings/supply-summary": { "post": { "operationId": "listings-post-supply-summary", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get seller supply summaries", "tags": [ "listings" ] } }, "/v1/listings/template": { "get": { "operationId": "listings-template", "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Download batch import Excel template", "tags": [ "listings" ] } }, "/v1/listings/{listingID}": { "get": { "operationId": "listings-get-by-listing-id", "parameters": [ { "description": "Listing CID or seller slug shortcut.", "in": "path", "name": "listingID", "required": true, "schema": { "description": "Listing CID or seller slug shortcut.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get public listing by listing ID (CID)", "tags": [ "listings" ] } }, "/v1/listings/{peerID}/{slug}": { "get": { "operationId": "listings-get-by-peer-slug", "parameters": [ { "description": "Seller peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Seller peer ID.", "type": "string" } }, { "description": "Listing slug.", "in": "path", "name": "slug", "required": true, "schema": { "description": "Listing slug.", "type": "string" } }, { "description": "Return cached listing when true.", "explode": false, "in": "query", "name": "usecache", "schema": { "description": "Return cached listing when true.", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get public listing by peer ID and slug", "tags": [ "listings" ] } }, "/v1/listings/{slug}": { "delete": { "operationId": "listings-delete", "parameters": [ { "description": "Listing slug to delete.", "in": "path", "name": "slug", "required": true, "schema": { "description": "Listing slug to delete.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete listing by slug", "tags": [ "listings" ] } }, "/v1/media/avatar": { "post": { "operationId": "media-post-avatar", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Upload store avatar image", "tags": [ "media" ] } }, "/v1/media/files": { "post": { "operationId": "media-post-file", "parameters": [ { "in": "header", "name": "Content-Type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Upload arbitrary media file (multipart)", "tags": [ "media" ] } }, "/v1/media/files/{fileID}": { "get": { "operationId": "media-get-file", "parameters": [ { "description": "CID of the stored file.", "in": "path", "name": "fileID", "required": true, "schema": { "description": "CID of the stored file.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Serve arbitrary media file binary", "tags": [ "media" ] } }, "/v1/media/header": { "post": { "operationId": "media-post-header", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Upload store header image", "tags": [ "media" ] } }, "/v1/media/images": { "post": { "operationId": "media-post-images", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Upload one or more images", "tags": [ "media" ] } }, "/v1/media/images/{imageID}": { "get": { "operationId": "media-get-image", "parameters": [ { "description": "CID of the stored image.", "in": "path", "name": "imageID", "required": true, "schema": { "description": "CID of the stored image.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Serve image binary by CID", "tags": [ "media" ] } }, "/v1/media/product-images": { "post": { "operationId": "media-post-product-images", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Upload product images with variants", "tags": [ "media" ] } }, "/v1/moderators": { "delete": { "operationId": "moderators-delete", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Withdraw moderator advertisement", "tags": [ "moderators" ] }, "get": { "operationId": "moderators-get", "parameters": [ { "explode": false, "in": "query", "name": "async", "schema": { "type": "boolean" } }, { "explode": false, "in": "query", "name": "asyncID", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "include", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Enumerate candidate moderators (async/sync)", "tags": [ "moderators" ] }, "post": { "operationId": "moderators-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Declare self as dispute moderator candidate", "tags": [ "moderators" ] } }, "/v1/notifications": { "get": { "operationId": "notifications-get-list", "parameters": [ { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "offsetID", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List notifications", "tags": [ "notifications" ] } }, "/v1/notifications/batch": { "post": { "operationId": "notifications-post-batch", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Batch mark read or delete notifications", "tags": [ "notifications" ] } }, "/v1/notifications/channel-types": { "get": { "operationId": "notifications-channel-types-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List notification channel types", "tags": [ "notifications" ] } }, "/v1/notifications/channels": { "get": { "operationId": "notifications-channels-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List notification channels", "tags": [ "notifications" ] }, "post": { "operationId": "notifications-channels-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create notification channel", "tags": [ "notifications" ] } }, "/v1/notifications/channels/detect-chat": { "post": { "operationId": "notifications-channels-detect-chat-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Detect chat binding for notification channel", "tags": [ "notifications" ] } }, "/v1/notifications/channels/{id}": { "delete": { "operationId": "notifications-channels-id-delete", "parameters": [ { "description": "Channel ID.", "in": "path", "name": "id", "required": true, "schema": { "description": "Channel ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete notification channel", "tags": [ "notifications" ] }, "put": { "operationId": "notifications-channels-id-put", "parameters": [ { "description": "Channel ID.", "in": "path", "name": "id", "required": true, "schema": { "description": "Channel ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update notification channel", "tags": [ "notifications" ] } }, "/v1/notifications/channels/{id}/test": { "post": { "operationId": "notifications-channels-id-test-post", "parameters": [ { "description": "Channel ID.", "in": "path", "name": "id", "required": true, "schema": { "description": "Channel ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Send test notification on channel", "tags": [ "notifications" ] } }, "/v1/notifications/count": { "get": { "operationId": "notifications-get-count", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Notification unread and total counts", "tags": [ "notifications" ] } }, "/v1/notifications/read": { "post": { "operationId": "notifications-post-read-all", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Mark all notifications as read", "tags": [ "notifications" ] } }, "/v1/notifications/{notifID}/read": { "post": { "operationId": "notifications-post-notif-read", "parameters": [ { "description": "Notification ID.", "in": "path", "name": "notifID", "required": true, "schema": { "description": "Notification ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Mark one notification as read", "tags": [ "notifications" ] } }, "/v1/orders": { "post": { "operationId": "orders-post-create-purchase", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Submit a new multi-item purchase order", "tags": [ "orders" ] } }, "/v1/orders/checkout-breakdown": { "post": { "operationId": "orders-post-checkout-breakdown", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Pricing breakdown preview", "tags": [ "orders" ] } }, "/v1/orders/estimate": { "post": { "operationId": "orders-post-estimate-total", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Estimate totals for checkout", "tags": [ "orders" ] } }, "/v1/orders/supply-quote": { "post": { "operationId": "orders-post-supply-quote", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Authenticated checkout supply preflight", "tags": [ "orders" ] } }, "/v1/orders/{orderID}": { "get": { "operationId": "orders-get-detail", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Order detail snapshot", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/cancel": { "post": { "operationId": "orders-post-cancel", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Broadcast cancel escrow transaction", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/complete": { "post": { "operationId": "orders-post-complete", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Finalize fully paid order (+ optional ratings)", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/confirm": { "post": { "operationId": "orders-post-confirm", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Buyer confirm or decline order", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/digital-assets": { "get": { "description": "Returns all digital entitlements (files, license keys, links) granted to the buyer after order confirmation. Guest checkout access requires the independent buyerPortalToken issued at order creation.", "operationId": "digital-assets-buyer-get", "parameters": [ { "description": "Order ID.", "example": "QmOrder123", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "examples": [ "QmOrder123" ], "type": "string" } }, { "description": "Independent buyer portal bearer token issued at guest order creation.", "in": "header", "name": "X-Buyer-Portal-Token", "schema": { "description": "Independent buyer portal bearer token issued at guest order creation.", "type": "string" } }, { "description": "Signed download URL expiry in seconds.", "explode": false, "in": "query", "name": "urlExpirySec", "schema": { "default": 3600, "description": "Signed download URL expiry in seconds.", "format": "int64", "maximum": 86400, "minimum": 60, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "List of digital entitlements for this order.", "items": { "$ref": "#/components/schemas/BuyerAssetEntry" }, "type": [ "array", "null" ] } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [], "summary": "Get buyer digital assets for an order", "tags": [ "digital-assets" ] } }, "/v1/orders/{orderID}/digital-delivery": { "get": { "description": "Returns the order-level digital delivery contract used by seller and buyer order pages. It exposes delivery state and counts only; digital secrets are returned by the buyer assets endpoint.", "operationId": "digital-delivery-status-get", "parameters": [ { "description": "Order ID.", "example": "QmOrder123", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "examples": [ "QmOrder123" ], "type": "string" } }, { "description": "Independent buyer portal bearer token issued at guest order creation.", "in": "header", "name": "X-Buyer-Portal-Token", "schema": { "description": "Independent buyer portal bearer token issued at guest order creation.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalDeliveryStatus", "description": "Order-level digital delivery status." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [], "summary": "Get digital delivery status for an order", "tags": [ "digital-assets" ] } }, "/v1/orders/{orderID}/digital-delivery/retry": { "post": { "description": "Replays automatic digital entitlement creation for a seller order. This is intended for recoverable cases where digital assets were added after payment confirmation.", "operationId": "digital-delivery-retry", "parameters": [ { "description": "Order ID.", "example": "QmOrder123", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "examples": [ "QmOrder123" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalDeliveryStatus", "description": "Order-level digital delivery status." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Retry digital delivery for an order", "tags": [ "digital-assets" ] } }, "/v1/orders/{orderID}/digital-download": { "get": { "description": "Serves the binary content of a purchased digital asset. Authentication is provided by the HMAC signature embedded in the query parameters (generated by the buyer portal API). No session or admin token required.", "operationId": "digital-download", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } }, { "description": "Grant nonce.", "explode": false, "in": "query", "name": "grant", "required": true, "schema": { "description": "Grant nonce.", "type": "string" } }, { "description": "Asset ID.", "explode": false, "in": "query", "name": "asset", "required": true, "schema": { "description": "Asset ID.", "type": "string" } }, { "description": "Expiry unix timestamp.", "explode": false, "in": "query", "name": "expires", "required": true, "schema": { "description": "Expiry unix timestamp.", "type": "string" } }, { "description": "Grant version.", "explode": false, "in": "query", "name": "v", "required": true, "schema": { "description": "Grant version.", "type": "string" } }, { "description": "HMAC-SHA256 hex signature.", "explode": false, "in": "query", "name": "sig", "required": true, "schema": { "description": "HMAC-SHA256 hex signature.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [], "summary": "Download a purchased digital file", "tags": [ "digital-assets" ] } }, "/v1/orders/{orderID}/extend-protection": { "post": { "operationId": "orders-post-extend-protection", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Buyer protection extension preview", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/instructions/cancel": { "post": { "operationId": "orders-post-instructions-cancel", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Cancellation / refund-before-ship instructions", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/instructions/complete": { "post": { "description": "Compatibility endpoint for client-signed moderated completion flows. backend-managed moderated completion stays on the backend-owned completion path and does not use this instructions contract as its primary entrypoint.", "operationId": "orders-post-instructions-complete", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Legacy completion payout instructions", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/instructions/confirm": { "post": { "operationId": "orders-post-instructions-confirm", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Confirmation / acceptance instructions", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/instructions/decline": { "post": { "operationId": "orders-post-instructions-decline", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Decline / refund-flow instructions via confirmation handler", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/instructions/refund": { "post": { "operationId": "orders-post-instructions-refund", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Refund instructions", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/payment": { "post": { "operationId": "orders-post-payment", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Buyer submit payment payloads", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/payment-selection-quotes": { "post": { "description": "Freezes the signed pricing amount, canonical payment asset, conversion rate, numeric provider/platform costs, target amount, policy version and expiry before PaymentSession provisioning.", "operationId": "orders-post-payment-selection-quote", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create immutable Deal payment-selection quote", "tags": [ "orders", "payments" ] } }, "/v1/orders/{orderID}/payment-session": { "get": { "description": "Returns a PaymentSession projection built from existing order and payment metadata. Settlement modes indicate observed-address, client-signed escrow, or provider-session execution.", "operationId": "orders-get-payment-session", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Unified payment session view for an order", "tags": [ "orders", "payments" ] }, "post": { "description": "Creates or idempotently returns a PaymentSession. Fiat: canonical paymentCoin fiat:{provider}:{currency}, fiatAmountCents (\u003e0), and optional PayPal return/cancel URLs. Crypto: optional refundAddress/payerAddress/moderator; buyers should declare refundAddress before paying. Deal cross-currency requests must include paymentSelectionQuoteID from the immutable quote endpoint.", "operationId": "orders-post-payment-session", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Provision unified payment session", "tags": [ "orders", "payments" ] } }, "/v1/orders/{orderID}/payment/cancel-partial": { "post": { "operationId": "orders-post-payment-cancel-partial", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Revert partial-payment watch / refund leftover", "tags": [ "orders", "payments" ] } }, "/v1/orders/{orderID}/payment/remaining": { "get": { "operationId": "orders-get-payment-remaining", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Outstanding underpayment totals", "tags": [ "orders", "payments" ] } }, "/v1/orders/{orderID}/payment/watch": { "delete": { "operationId": "orders-delete-payment-watch", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Stop address watcher for UX tear-down", "tags": [ "orders", "payments" ] } }, "/v1/orders/{orderID}/rate": { "post": { "operationId": "orders-post-rate", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Seller/buyer rate order fulfillment", "tags": [ "orders", "ratings" ] } }, "/v1/orders/{orderID}/refund": { "post": { "operationId": "orders-post-refund", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Finalize refund transaction", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/refund-address": { "post": { "description": "Validates and persists the buyer-controlled crypto refund destination. Requires buyer role. paymentCoin is optional when the order already has a selected coin.", "operationId": "orders-post-refund-address", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Set buyer refund wallet address", "tags": [ "orders", "payments" ] } }, "/v1/orders/{orderID}/rwa-token/payment-info": { "post": { "description": "Returns buyer and vendor chain identity addresses for RWA token purchases.", "operationId": "orders-post-rwa-token-payment-info", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get RWA token identity payment info", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/settlement-actions/{action}": { "post": { "description": "Runs Core-authorized backend settlement for supported crypto routes. Supported actions: confirm, cancel, seller-decline-refund, complete, dispute-release. Client-signed legacy chains use instruction endpoints. Fiat orders return 400. Optional body: payoutAddress.", "operationId": "orders-post-settlement-action", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } }, { "description": "Settlement intent: confirm, cancel, seller-decline-refund, complete, or dispute-release.", "in": "path", "name": "action", "required": true, "schema": { "description": "Settlement intent: confirm, cancel, seller-decline-refund, complete, or dispute-release.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Execute backend settlement action", "tags": [ "orders", "payments" ] } }, "/v1/orders/{orderID}/settlement-actions/{action}/status": { "get": { "description": "Returns the latest status for a previously issued backend settlement action. backend-managed flows expose relay task correlation and confirmations through this endpoint.", "operationId": "orders-get-settlement-action-status", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } }, { "description": "Settlement intent: confirm, cancel, seller-decline-refund, complete, or dispute-release.", "in": "path", "name": "action", "required": true, "schema": { "description": "Settlement intent: confirm, cancel, seller-decline-refund, complete, or dispute-release.", "type": "string" } }, { "description": "Opaque settlement action poll key returned by POST settlement-actions.", "explode": false, "in": "query", "name": "actionId", "required": true, "schema": { "description": "Opaque settlement action poll key returned by POST settlement-actions.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Read unified settlement action status", "tags": [ "orders", "payments" ] } }, "/v1/orders/{orderID}/ship": { "post": { "operationId": "orders-post-ship", "parameters": [ { "description": "Order ID.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Fulfill shipments", "tags": [ "orders" ] } }, "/v1/orders/{orderID}/spend": { "post": { "operationId": "orders-post-spend-for-order", "parameters": [ { "description": "Order ID targeted for spends.", "in": "path", "name": "orderID", "required": true, "schema": { "description": "Order ID targeted for spends.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Execute wallet spend in order context", "tags": [ "orders", "wallet" ] } }, "/v1/payment-methods/{peerID}": { "get": { "operationId": "payment-methods-get-by-peer-id", "parameters": [ { "description": "Storefront seller peer scope.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Storefront seller peer scope.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Public storefront payment rails summary", "tags": [ "payments" ] } }, "/v1/peers": { "get": { "operationId": "peers-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Enumerate libp2p peers (standalone only)", "tags": [ "system" ] } }, "/v1/posts": { "post": { "operationId": "posts-create", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Publish a storefront post", "tags": [ "posts" ] } }, "/v1/posts/{peerID}/{slug}": { "get": { "operationId": "posts-get-public-by-peer-slug", "parameters": [ { "description": "Author peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Author peer ID.", "type": "string" } }, { "description": "Post slug.", "in": "path", "name": "slug", "required": true, "schema": { "description": "Post slug.", "type": "string" } }, { "description": "Return cached post when true.", "explode": false, "in": "query", "name": "usecache", "schema": { "description": "Return cached post when true.", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Fetch a public storefront post", "tags": [ "posts" ] } }, "/v1/posts/{slug}": { "delete": { "operationId": "posts-delete", "parameters": [ { "description": "Post slug to delete.", "in": "path", "name": "slug", "required": true, "schema": { "description": "Post slug to delete.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete a post owned by authenticated seller", "tags": [ "posts" ] }, "get": { "operationId": "posts-get-own-by-slug", "parameters": [ { "description": "Post slug for authenticated context.", "in": "path", "name": "slug", "required": true, "schema": { "description": "Post slug for authenticated context.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Fetch seller-owned post draft by slug", "tags": [ "posts" ] } }, "/v1/preferences": { "get": { "operationId": "preferences-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get user preferences", "tags": [ "settings" ] }, "put": { "operationId": "preferences-put", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update user preferences", "tags": [ "settings" ] } }, "/v1/preferences/currency": { "post": { "operationId": "preferences-currency-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Bulk update listing currency preferences", "tags": [ "settings" ] } }, "/v1/profiles": { "get": { "operationId": "profiles-get-self", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get profile for implicit context (self or anonymous)", "tags": [ "profiles" ] }, "post": { "operationId": "profiles-create", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create profile (authenticated peer)", "tags": [ "profiles" ] }, "put": { "operationId": "profiles-update", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Patch profile merge (authenticated peer)", "tags": [ "profiles" ] } }, "/v1/profiles/batch": { "get": { "operationId": "profiles-batch-fetch-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Batch fetch profiles (GET; body often empty—legacy accepts JSON array of peer IDs via POST)", "tags": [ "profiles" ] }, "post": { "operationId": "profiles-batch-fetch-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Batch fetch profiles by peer ID list", "tags": [ "profiles" ] } }, "/v1/profiles/{peerID}": { "get": { "operationId": "profiles-get-by-peer-id", "parameters": [ { "description": "Public profile peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Public profile peer ID.", "type": "string" } }, { "description": "Return cached profile when true.", "explode": false, "in": "query", "name": "usecache", "schema": { "description": "Return cached profile when true.", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get public profile by peer ID", "tags": [ "profiles" ] }, "post": { "operationId": "profiles-create-scoped", "parameters": [ { "description": "Target peer ID (must match caller).", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Target peer ID (must match caller).", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create profile with explicit peer path", "tags": [ "profiles" ] }, "put": { "operationId": "profiles-update-scoped", "parameters": [ { "description": "Profile peer segment (must match caller).", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Profile peer segment (must match caller).", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Patch profile with explicit peer path", "tags": [ "profiles" ] } }, "/v1/profiles/{peerID}/avatar/{size}": { "get": { "operationId": "profiles-get-avatar", "parameters": [ { "description": "Profile peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Profile peer ID.", "type": "string" } }, { "description": "Rendered image size key.", "in": "path", "name": "size", "required": true, "schema": { "description": "Rendered image size key.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Serve profile avatar image", "tags": [ "profiles" ] } }, "/v1/profiles/{peerID}/header/{size}": { "get": { "operationId": "profiles-get-header", "parameters": [ { "description": "Profile peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Profile peer ID.", "type": "string" } }, { "description": "Rendered image size key.", "in": "path", "name": "size", "required": true, "schema": { "description": "Rendered image size key.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Serve profile header image", "tags": [ "profiles" ] } }, "/v1/purchases": { "get": { "operationId": "purchases-get-query", "parameters": [ { "explode": false, "in": "query", "name": "state", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "search", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Buyer purchase history", "tags": [ "orders", "purchases" ] }, "post": { "operationId": "purchases-post-query", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Search purchases via POST JSON filter", "tags": [ "orders", "purchases" ] } }, "/v1/ratings/batch": { "post": { "operationId": "ratings-batch-fetch", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Hydrate ratings by identifier list", "tags": [ "ratings" ] } }, "/v1/ratings/index": { "get": { "operationId": "ratings-index-self", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Seller rating index scoped to authenticated node", "tags": [ "ratings" ] } }, "/v1/ratings/index/{peerIDOrSlug}": { "get": { "operationId": "ratings-index-by-peer-or-slug", "parameters": [ { "description": "Peer ID literal or ambiguous slug resolver input.", "in": "path", "name": "peerIDOrSlug", "required": true, "schema": { "description": "Peer ID literal or ambiguous slug resolver input.", "type": "string" } }, { "description": "Return cached rating index when true.", "explode": false, "in": "query", "name": "usecache", "schema": { "description": "Return cached rating index when true.", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Aggregated ratings index for slug or decoded peer identifier", "tags": [ "ratings" ] } }, "/v1/ratings/index/{peerID}/{slug}": { "get": { "operationId": "ratings-index-by-peer-and-slug", "parameters": [ { "description": "Seller peer identifier.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Seller peer identifier.", "type": "string" } }, { "description": "Listing slug filter.", "in": "path", "name": "slug", "required": true, "schema": { "description": "Listing slug filter.", "type": "string" } }, { "description": "Return cached rating index when true.", "explode": false, "in": "query", "name": "usecache", "schema": { "description": "Return cached rating index when true.", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Slice of ratings scoped to slug for a seller", "tags": [ "ratings" ] } }, "/v1/ratings/{ratingID}": { "get": { "operationId": "ratings-get-by-id", "parameters": [ { "description": "CID of SignedRating protobuf.", "in": "path", "name": "ratingID", "required": true, "schema": { "description": "CID of SignedRating protobuf.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Retrieve a normalized rating blob", "tags": [ "ratings" ] } }, "/v1/runtime-config": { "get": { "operationId": "runtime-config-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Frontend runtime features and capabilities", "tags": [ "system" ] } }, "/v1/sales": { "get": { "operationId": "sales-get-query", "parameters": [ { "explode": false, "in": "query", "name": "type", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "state", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "search", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "page", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "pageSize", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Seller sales feed", "tags": [ "orders", "sales" ] }, "post": { "operationId": "sales-post-query", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Seller sales POST filter", "tags": [ "orders", "sales" ] } }, "/v1/settings/ai": { "get": { "operationId": "settings-ai-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get AI integration config", "tags": [ "ai" ] }, "put": { "operationId": "settings-ai-put", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update AI integration config", "tags": [ "ai" ] } }, "/v1/settings/ai/providers": { "get": { "operationId": "settings-ai-providers-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List supported AI providers", "tags": [ "ai" ] } }, "/v1/settings/ai/test": { "post": { "operationId": "settings-ai-test-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Test AI provider connection", "tags": [ "ai" ] } }, "/v1/settings/features/{key}": { "put": { "operationId": "settings-feature-put", "parameters": [ { "description": "Feature flag key.", "in": "path", "name": "key", "required": true, "schema": { "description": "Feature flag key.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update a feature flag", "tags": [ "settings" ] } }, "/v1/settings/guest-checkout": { "get": { "operationId": "settings-guest-checkout-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get guest checkout settings", "tags": [ "settings" ] }, "put": { "operationId": "settings-guest-checkout-put", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update guest checkout settings", "tags": [ "settings" ] } }, "/v1/settings/guest-checkout/readiness": { "get": { "operationId": "settings-guest-checkout-readiness-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get guest checkout UTXO readiness", "tags": [ "settings" ] } }, "/v1/settings/payment-policy": { "get": { "operationId": "settings-payment-policy-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get store payment policy", "tags": [ "settings" ] }, "put": { "operationId": "settings-payment-policy-put", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update store payment policy", "tags": [ "settings" ] } }, "/v1/settings/pgp-key": { "delete": { "operationId": "settings-pgp-key-delete", "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Remove seller PGP public key", "tags": [ "settings" ] }, "get": { "operationId": "settings-pgp-key-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get seller PGP public key (public)", "tags": [ "settings" ] }, "put": { "operationId": "settings-pgp-key-put", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Set seller PGP public key", "tags": [ "settings" ] } }, "/v1/settings/pgp-key/vault": { "get": { "operationId": "settings-pgp-key-vault-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Get seller encrypted PGP key backup", "tags": [ "settings" ] } }, "/v1/settings/storefront": { "get": { "operationId": "settings-storefront-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get storefront branding (seller)", "tags": [ "settings" ] }, "put": { "operationId": "settings-storefront-put", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update storefront branding", "tags": [ "settings" ] } }, "/v1/settings/storefront/{peerID}": { "get": { "operationId": "settings-storefront-public-get", "parameters": [ { "description": "Store peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Store peer ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get storefront branding (public)", "tags": [ "settings" ] } }, "/v1/shipping/locations": { "get": { "operationId": "shipping-locations-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List shipping locations", "tags": [ "shipping" ] }, "post": { "operationId": "shipping-locations-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create shipping location", "tags": [ "shipping" ] } }, "/v1/shipping/locations/{locationID}": { "delete": { "operationId": "shipping-locations-id-delete", "parameters": [ { "description": "Shipping location ID.", "in": "path", "name": "locationID", "required": true, "schema": { "description": "Shipping location ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete shipping location", "tags": [ "shipping" ] }, "get": { "operationId": "shipping-locations-id-get", "parameters": [ { "description": "Shipping location ID.", "in": "path", "name": "locationID", "required": true, "schema": { "description": "Shipping location ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get shipping location", "tags": [ "shipping" ] }, "put": { "operationId": "shipping-locations-id-put", "parameters": [ { "in": "path", "name": "locationID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update shipping location", "tags": [ "shipping" ] } }, "/v1/shipping/profiles": { "get": { "operationId": "shipping-profiles-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List shipping profiles", "tags": [ "shipping" ] }, "post": { "operationId": "shipping-profiles-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create shipping profile", "tags": [ "shipping" ] } }, "/v1/shipping/profiles/{profileID}": { "delete": { "operationId": "shipping-profiles-id-delete", "parameters": [ { "in": "path", "name": "profileID", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "migrateTo", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete shipping profile", "tags": [ "shipping" ] }, "get": { "operationId": "shipping-profiles-id-get", "parameters": [ { "description": "Shipping profile ID.", "in": "path", "name": "profileID", "required": true, "schema": { "description": "Shipping profile ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get shipping profile", "tags": [ "shipping" ] }, "patch": { "operationId": "shipping-profiles-id-patch", "parameters": [ { "in": "path", "name": "profileID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Patch shipping profile", "tags": [ "shipping" ] }, "put": { "operationId": "shipping-profiles-id-put", "parameters": [ { "in": "path", "name": "profileID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Replace shipping profile", "tags": [ "shipping" ] } }, "/v1/shipping/profiles/{profileID}/listings": { "get": { "operationId": "shipping-profiles-listings-get", "parameters": [ { "in": "path", "name": "profileID", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "page", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "pageSize", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Paginated listings using a shipping profile", "tags": [ "shipping" ] } }, "/v1/shipping/profiles/{profileID}/set-default": { "post": { "operationId": "shipping-profiles-default-post", "parameters": [ { "description": "Shipping profile ID.", "in": "path", "name": "profileID", "required": true, "schema": { "description": "Shipping profile ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Set default shipping profile", "tags": [ "shipping" ] } }, "/v1/shipping/refresh-snapshots": { "post": { "operationId": "shipping-refresh-snapshots-post", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Refresh stale listing shipping snapshots", "tags": [ "shipping" ] } }, "/v1/shipping/stale-listings": { "get": { "operationId": "shipping-stale-listings-get", "parameters": [ { "explode": false, "in": "query", "name": "page", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "pageSize", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List stale shipping snapshots", "tags": [ "shipping" ] } }, "/v1/store-policy": { "get": { "operationId": "store-policy-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get store policy", "tags": [ "store-policy" ] } }, "/v1/store-policy/moderators": { "get": { "operationId": "store-policy-moderators-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List store moderators", "tags": [ "store-policy" ] }, "post": { "operationId": "store-policy-moderators-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Add or update store moderator", "tags": [ "store-policy" ] }, "put": { "operationId": "store-policy-moderators-put", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Replace store moderators", "tags": [ "store-policy" ] } }, "/v1/store-policy/moderators/{peerID}": { "delete": { "operationId": "store-policy-moderators-peer-delete", "parameters": [ { "description": "Moderator peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Moderator peer ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Remove store moderator", "tags": [ "store-policy" ] } }, "/v1/store-policy/{peerID}/published": { "get": { "operationId": "store-policy-peer-published-get", "parameters": [ { "description": "Store peer ID.", "in": "path", "name": "peerID", "required": true, "schema": { "description": "Store peer ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Get published store policy", "tags": [ "store-policy" ] } }, "/v1/stores/{storeID}/licenses/activate": { "post": { "description": "Binds a license key to a device fingerprint. Returns existing activation if already activated for this fingerprint.", "operationId": "license-activate", "parameters": [ { "description": "Store identifier (peerID or handle).", "in": "path", "name": "storeID", "required": true, "schema": { "description": "Store identifier (peerID or handle).", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/License-activateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseActivationResult" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [], "summary": "Activate a license key on a device", "tags": [ "licenses" ] } }, "/v1/stores/{storeID}/licenses/deactivate": { "post": { "description": "Unbinds a license key from a device fingerprint, freeing up an activation slot.", "operationId": "license-deactivate", "parameters": [ { "description": "Store identifier (peerID or handle).", "in": "path", "name": "storeID", "required": true, "schema": { "description": "Store identifier (peerID or handle).", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/License-deactivateRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [], "summary": "Deactivate a license key on a device", "tags": [ "licenses" ] } }, "/v1/stores/{storeID}/licenses/validate": { "post": { "description": "Checks whether a license key is valid and returns its status. Public endpoint for use by third-party software.", "operationId": "license-validate", "parameters": [ { "description": "Store identifier (peerID or handle). Used for multi-tenant routing in SaaS mode.", "in": "path", "name": "storeID", "required": true, "schema": { "description": "Store identifier (peerID or handle). Used for multi-tenant routing in SaaS mode.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/License-validateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseValidationResult" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [], "summary": "Validate a license key", "tags": [ "licenses" ] } }, "/v1/system/cache": { "delete": { "operationId": "system-cache-delete", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Purge publishing cache", "tags": [ "system" ] } }, "/v1/system/claim-store": { "post": { "operationId": "system-claim-store-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Claim standalone store via JWT + admin proof", "tags": [ "system" ] } }, "/v1/system/connect-platform": { "post": { "operationId": "system-connect-platform-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Bind standalone store owner to SaaS identity", "tags": [ "system" ] } }, "/v1/system/diagnostics": { "get": { "operationId": "system-diagnostics-get", "responses": { "200": { "content": { "application/json": { "schema": { "contentEncoding": "base64", "type": "string" } } }, "description": "OK", "headers": { "Cache-Control": { "schema": { "description": "Cache directive.", "type": "string" } }, "Content-Disposition": { "schema": { "description": "Attachment hint for downloads.", "type": "string" } }, "Content-Security-Policy": { "schema": { "description": "Content security policy from legacy handler.", "type": "string" } }, "Content-Type": { "schema": { "description": "MIME type from legacy handler.", "type": "string" } }, "ETag": { "schema": { "description": "Entity tag from legacy handler.", "type": "string" } }, "X-Content-Type-Options": { "schema": { "description": "MIME sniffing policy from legacy handler.", "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Export structured diagnostics blob", "tags": [ "system" ] } }, "/v1/system/doctor": { "get": { "operationId": "system-doctor-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Run self-check diagnostics snapshot", "tags": [ "system" ] } }, "/v1/system/domain": { "get": { "operationId": "system-domain-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Inspect store domain bindings", "tags": [ "system" ] }, "post": { "operationId": "system-domain-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Update store domain configuration", "tags": [ "system" ] } }, "/v1/system/health": { "get": { "operationId": "system-health-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Node health and telemetry", "tags": [ "system" ] } }, "/v1/system/huma-ping": { "get": { "description": "Returns a static greeting and server time.", "operationId": "node-huma-ping", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HumaNodePingOutputBody" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Huma pipeline smoke test", "tags": [ "system" ] } }, "/v1/system/info": { "get": { "operationId": "system-info-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Get system/network info snapshot", "tags": [ "system" ] } }, "/v1/system/logs": { "get": { "operationId": "system-logs-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Tail recent node log lines", "tags": [ "system" ] } }, "/v1/system/mcp/capability": { "get": { "operationId": "system-mcp-capability-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Detect MCP client capabilities", "tags": [ "system", "ai" ] } }, "/v1/system/mcp/clients": { "get": { "operationId": "system-mcp-clients-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "List configured MCP clients", "tags": [ "system", "ai" ] } }, "/v1/system/mcp/connect": { "post": { "operationId": "system-mcp-connect-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Auto-configure MCP client", "tags": [ "system", "ai" ] } }, "/v1/system/mcp/connect/{client}": { "post": { "operationId": "system-mcp-connect-client-post", "parameters": [ { "in": "path", "name": "client", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Auto-configure a specific MCP client", "tags": [ "system", "ai" ] } }, "/v1/system/mcp/disconnect": { "post": { "operationId": "system-mcp-disconnect-post", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Remove MCP integration", "tags": [ "system", "ai" ] } }, "/v1/system/mcp/disconnect/{client}": { "post": { "operationId": "system-mcp-disconnect-client-post", "parameters": [ { "in": "path", "name": "client", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Remove integration for one MCP client", "tags": [ "system", "ai" ] } }, "/v1/system/network": { "get": { "operationId": "system-network-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Inspect network overlays and listening multiaddrs", "tags": [ "system" ] }, "post": { "operationId": "system-network-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Change network overlays (standalone)", "tags": [ "system" ] } }, "/v1/system/publish": { "post": { "operationId": "system-publish-post", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Publish store data", "tags": [ "system" ] } }, "/v1/system/setup": { "get": { "operationId": "system-setup-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Standalone onboarding status (public)", "tags": [ "system" ] }, "post": { "operationId": "system-setup-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "summary": "Standalone one-time password setup", "tags": [ "system" ] } }, "/v1/system/shutdown": { "post": { "operationId": "system-shutdown-post", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Shutdown standalone node process", "tags": [ "system" ] } }, "/v1/system/update-config": { "get": { "operationId": "system-update-config-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Read auto-update configuration sidecar", "tags": [ "system" ] }, "put": { "operationId": "system-update-config-put", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Write auto-update configuration sidecar", "tags": [ "system" ] } }, "/v1/system/update-trigger": { "post": { "operationId": "system-update-trigger-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "adminSession": [] } ], "summary": "Ask launcher/native updater to action", "tags": [ "system" ] } }, "/v1/wallet/currencies": { "get": { "operationId": "wallet-get-currencies", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List supported wallet currencies", "tags": [ "wallet" ] } }, "/v1/wallet/mnemonic": { "get": { "operationId": "wallet-get-mnemonic", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get wallet mnemonic seed phrase", "tags": [ "wallet" ] } }, "/v1/wallet/receiving-accounts": { "get": { "operationId": "wallet-list-receiving-accounts", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List receiving accounts", "tags": [ "wallet" ] }, "post": { "operationId": "wallet-create-receiving-account", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Add a receiving account", "tags": [ "wallet" ] }, "put": { "operationId": "wallet-update-receiving-account", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update a receiving account", "tags": [ "wallet" ] } }, "/v1/wallet/receiving-accounts/{id}": { "delete": { "operationId": "wallet-delete-receiving-account", "parameters": [ { "description": "Receiving account ID to delete.", "in": "path", "name": "id", "required": true, "schema": { "description": "Receiving account ID to delete.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete a receiving account", "tags": [ "wallet" ] } }, "/v1/wallet/spend": { "post": { "operationId": "wallet-spend", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Send cryptocurrency from wallet", "tags": [ "wallet" ] } }, "/v1/webhooks": { "get": { "operationId": "webhooks-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List webhook endpoints", "tags": [ "webhooks" ] }, "post": { "operationId": "webhooks-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Create webhook endpoint", "tags": [ "webhooks" ] } }, "/v1/webhooks/{id}": { "delete": { "operationId": "webhooks-id-delete", "parameters": [ { "description": "Webhook endpoint ID.", "in": "path", "name": "id", "required": true, "schema": { "description": "Webhook endpoint ID.", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Delete webhook endpoint", "tags": [ "webhooks" ] }, "get": { "operationId": "webhooks-id-get", "parameters": [ { "description": "Webhook endpoint ID.", "in": "path", "name": "id", "required": true, "schema": { "description": "Webhook endpoint ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Get webhook endpoint", "tags": [ "webhooks" ] }, "patch": { "operationId": "webhooks-id-patch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Update webhook endpoint", "tags": [ "webhooks" ] } }, "/v1/webhooks/{id}/deliveries": { "get": { "operationId": "webhooks-id-deliveries-get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "limit", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "offset", "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "status", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List webhook delivery attempts", "tags": [ "webhooks" ] } }, "/v1/webhooks/{id}/test": { "post": { "operationId": "webhooks-id-test-post", "parameters": [ { "description": "Webhook endpoint ID.", "in": "path", "name": "id", "required": true, "schema": { "description": "Webhook endpoint ID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Enqueue test webhook event", "tags": [ "webhooks" ] } }, "/v1/wishlists": { "get": { "operationId": "wishlists-get", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "List wishlist items", "tags": [ "wishlists" ] }, "post": { "operationId": "wishlists-post", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Success envelope inner data." } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Add item to wishlist", "tags": [ "wishlists" ] } }, "/v1/wishlists/{peerID}/{slug}": { "delete": { "operationId": "wishlists-peer-slug-delete", "parameters": [ { "in": "path", "name": "peerID", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeError" } } }, "description": "Error" } }, "security": [ { "basicAuth": [] }, { "bearerJWT": [] }, { "apiToken": [] }, { "adminSession": [] } ], "summary": "Remove wishlist item", "tags": [ "wishlists" ] } } }, "servers": [ { "description": "Node gateway", "url": "/" } ] }