generated: '2026-07-15'
method: generated
source: openapi/smartrr-openapi.yml
description: Recommended x-agentic-access execution contracts, classified heuristically from
  the OpenAPI. A governance starting point for exposing this API to AI agents — review and bind
  audience per deployment. See research/curity/agentic-governance/.
summary:
  operations: 43
  by_action_class:
    connected: 22
    acting: 21
  by_consequence:
    read: 22
    physical: 15
    write: 6
  human_in_the_loop_required: 0
operations:
- path: /vendor/purchase-state
  method: get
  operationId: getPurchaseStates
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/purchase-state
  method: post
  operationId: createPurchaseState
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/purchase-state/{shopifySubscriptionId}
  method: get
  operationId: getPurchaseStateByShopifyId
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/purchase-state/{shopifySubscriptionId}/orders
  method: get
  operationId: getPurchaseStateOrders
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/purchase-state/{shopifySubscriptionId}/bills
  method: get
  operationId: getPurchaseStateBills
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/purchase-state/{shopifySubscriptionId}/events
  method: get
  operationId: getPurchaseStateEvents
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/customer/{customerRelationshipId}/purchase-state/
  method: get
  operationId: getPurchaseStatesByCustomer
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/skip
  method: put
  operationId: skipPurchase
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/unskip
  method: put
  operationId: unskipPurchase
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/pause
  method: put
  operationId: pausePurchase
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/activate
  method: put
  operationId: activatePurchase
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/cancel
  method: put
  operationId: cancelPurchase
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/next-billing-date
  method: put
  operationId: setNextBillingDate
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/selling-plan
  method: put
  operationId: setSellingPlanOnPurchase
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/line-item
  method: post
  operationId: addLineItem
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/purchase-state/bulk-cancel
  method: put
  operationId: bulkCancelPurchases
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/purchase-state/bulk-pause
  method: put
  operationId: bulkPausePurchases
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer-relationship
  method: get
  operationId: getCustomerRelationships
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/customer-relationship/{customerShopifyId}
  method: get
  operationId: getCustomerRelationshipByShopifyId
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/customer-relationship/{customerRelationshipId}/payment-methods
  method: get
  operationId: getPaymentMethods
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/customer-relationship/{customerShopifyId}/referral-link
  method: get
  operationId: getReferralLink
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/customer-relationship/{customerRelationshipId}/orgPoints
  method: put
  operationId: addLoyaltyPoints
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer-relationship/import
  method: post
  operationId: importCustomerRelationship
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/customer/{custRelId}/orders
  method: get
  operationId: getOrdersByCustomer
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/order
  method: get
  operationId: getOrders
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/order/formatted
  method: get
  operationId: getFormattedOrders
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/orders/{shopifyId}
  method: get
  operationId: getOrderByShopifyId
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/order/{orderId}/open
  method: post
  operationId: openOrder
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/order/{orderId}
  method: delete
  operationId: closeOrder
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/bill
  method: get
  operationId: getBills
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/bill/{billId}/history
  method: get
  operationId: getBillHistory
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/bill/{billId}/retry
  method: post
  operationId: retryBill
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/bill/{billId}/cancel
  method: post
  operationId: cancelBill
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/purchasable
  method: get
  operationId: getPurchasables
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/purchasable
  method: put
  operationId: updatePurchasable
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/purchasable/{id}
  method: get
  operationId: getPurchasableById
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/purchasable-collection
  method: get
  operationId: getPurchasableCollection
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/selling-plan-group
  method: get
  operationId: getSellingPlanGroups
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/selling-plan-configs
  method: get
  operationId: getSellingPlanConfigs
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/webhook
  method: get
  operationId: getWebhooks
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /vendor/webhook
  method: post
  operationId: createWebhook
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/webhook/{webhookId}
  method: put
  operationId: editWebhook
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /vendor/webhook/{webhookId}
  method: delete
  operationId: deleteWebhook
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required