vocabulary: 1.0.0
info:
  provider: Square
  description: Unified vocabulary mapping Square Connect API operational primitives to Naftiko capability workflows.
  created: '2026-04-18'
  modified: '2026-06-03'
operational:
  apis:
  - name: Square Payments API
    namespace: payments-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Orders API
    namespace: orders-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Catalog API
    namespace: catalog-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Inventory API
    namespace: inventory-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Customers API
    namespace: customers-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Locations API
    namespace: locations-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Team API
    namespace: team-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Labor API
    namespace: labor-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Bookings API
    namespace: bookings-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Loyalty API
    namespace: loyalty-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Gift Cards API
    namespace: gift-cards-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Invoices API
    namespace: invoices-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Subscriptions API
    namespace: subscriptions-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Checkout API
    namespace: checkout-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Terminal API
    namespace: terminal-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Refunds API
    namespace: refunds-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Disputes API
    namespace: disputes-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Merchants API
    namespace: merchants-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Cards API
    namespace: cards-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Vendors API
    namespace: vendors-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Cash Drawers API
    namespace: cash-drawers-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Bank Accounts API
    namespace: bank-accounts-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Payouts API
    namespace: payouts-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Apple Pay API
    namespace: apple-pay-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Sites API
    namespace: sites-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Snippets API
    namespace: snippets-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square OAuth API
    namespace: oauth-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Webhook Subscriptions API
    namespace: webhook-subscriptions-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Events API
    namespace: events-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Devices API
    namespace: devices-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Customer Groups API
    namespace: customer-groups-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Customer Segments API
    namespace: customer-segments-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Gift Card Activities API
    namespace: gift-card-activities-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Custom Attributes API
    namespace: custom-attributes-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Reporting API
    namespace: reporting-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Channels API
    namespace: channels-api
    baseUrl: https://connect.squareup.com
    status: active
  - name: Square Transfer Orders API
    namespace: transfer-orders-api
    baseUrl: https://connect.squareup.com
    status: active
  resources:
  - name: ApplePay
    actions:
    - register
  - name: BankAccounts
    actions:
    - get
    - list
  - name: BookingCustomAttributes
    actions:
    - bulk
    - create
    - delete
    - list
    - retrieve
    - update
    - upsert
  - name: Bookings
    actions:
    - bulk
    - cancel
    - create
    - list
    - retrieve
    - search
    - update
  - name: Cards
    actions:
    - create
    - disable
    - list
    - retrieve
  - name: CashDrawers
    actions:
    - list
    - retrieve
  - name: Catalog
    actions:
    - batch
    - catalog
    - create
    - delete
    - list
    - retrieve
    - search
    - update
    - upsert
  - name: Checkout
    actions:
    - create
    - delete
    - list
    - retrieve
    - update
  - name: CustomerCustomAttributes
    actions:
    - bulk
    - create
    - delete
    - list
    - retrieve
    - update
    - upsert
  - name: CustomerGroups
    actions:
    - create
    - delete
    - list
    - retrieve
    - update
  - name: CustomerSegments
    actions:
    - list
    - retrieve
  - name: Customers
    actions:
    - add
    - bulk
    - create
    - delete
    - list
    - remove
    - retrieve
    - search
    - update
  - name: Devices
    actions:
    - create
    - get
    - list
  - name: Disputes
    actions:
    - accept
    - create
    - delete
    - list
    - retrieve
    - submit
  - name: Employees
    actions:
    - list
    - retrieve
  - name: Events
    actions:
    - disable
    - enable
    - list
    - search
  - name: GiftCardActivities
    actions:
    - create
    - list
  - name: GiftCards
    actions:
    - create
    - link
    - list
    - retrieve
    - unlink
  - name: Inventory
    actions:
    - batch
    - deprecated
    - retrieve
  - name: Invoices
    actions:
    - cancel
    - create
    - delete
    - get
    - list
    - publish
    - search
    - update
  - name: Labor
    actions:
    - create
    - delete
    - get
    - list
    - search
    - update
  - name: LocationCustomAttributes
    actions:
    - bulk
    - create
    - delete
    - list
    - retrieve
    - update
    - upsert
  - name: Locations
    actions:
    - create
    - list
    - retrieve
    - update
  - name: Loyalty
    actions:
    - accumulate
    - adjust
    - calculate
    - cancel
    - create
    - delete
    - list
    - redeem
    - retrieve
    - search
  - name: MerchantCustomAttributes
    actions:
    - bulk
    - create
    - delete
    - list
    - retrieve
    - update
    - upsert
  - name: Merchants
    actions:
    - list
    - retrieve
  - name: MobileAuthorization
    actions:
    - create
  - name: OAuth
    actions:
    - obtain
    - retrieve
    - revoke
  - name: OrderCustomAttributes
    actions:
    - bulk
    - create
    - delete
    - list
    - retrieve
    - update
    - upsert
  - name: Orders
    actions:
    - batch
    - calculate
    - clone
    - create
    - pay
    - retrieve
    - search
    - update
  - name: Payments
    actions:
    - cancel
    - complete
    - create
    - get
    - list
    - update
  - name: Payouts
    actions:
    - get
    - list
  - name: Refunds
    actions:
    - get
    - list
    - refund
  - name: Sites
    actions:
    - list
  - name: Snippets
    actions:
    - delete
    - retrieve
    - upsert
  - name: Subscriptions
    actions:
    - bulk
    - cancel
    - change
    - create
    - delete
    - list
    - pause
    - resume
    - retrieve
    - search
    - swap
    - update
  - name: Team
    actions:
    - bulk
    - create
    - list
    - retrieve
    - search
    - update
  - name: Terminal
    actions:
    - cancel
    - create
    - dismiss
    - get
    - search
  - name: Transactions
    actions:
    - capture
    - list
    - retrieve
    - void
  - name: V1Transactions
    actions:
    - v1
  - name: Vendors
    actions:
    - bulk
    - create
    - retrieve
    - search
    - update
  - name: WebhookSubscriptions
    actions:
    - create
    - delete
    - list
    - retrieve
    - test
    - update
  actions:
  - verb: accept
    pattern: write
  - verb: accumulate
    pattern: write
  - verb: add
    pattern: write
  - verb: adjust
    pattern: write
  - verb: batch
    pattern: write
  - verb: bulk
    pattern: write
  - verb: calculate
    pattern: read
  - verb: cancel
    pattern: destructive
  - verb: capture
    pattern: write
  - verb: catalog
    pattern: write
  - verb: change
    pattern: write
  - verb: clone
    pattern: write
  - verb: complete
    pattern: write
  - verb: create
    pattern: write
  - verb: delete
    pattern: destructive
  - verb: deprecated
    pattern: write
  - verb: disable
    pattern: destructive
  - verb: dismiss
    pattern: write
  - verb: enable
    pattern: write
  - verb: get
    pattern: read
  - verb: link
    pattern: write
  - verb: list
    pattern: query
  - verb: obtain
    pattern: write
  - verb: pause
    pattern: write
  - verb: pay
    pattern: write
  - verb: publish
    pattern: write
  - verb: redeem
    pattern: write
  - verb: refund
    pattern: write
  - verb: register
    pattern: write
  - verb: remove
    pattern: write
  - verb: resume
    pattern: write
  - verb: retrieve
    pattern: read
  - verb: revoke
    pattern: destructive
  - verb: search
    pattern: query
  - verb: submit
    pattern: write
  - verb: swap
    pattern: write
  - verb: test
    pattern: read
  - verb: unlink
    pattern: write
  - verb: update
    pattern: write
  - verb: upsert
    pattern: write
  - verb: v1
    pattern: write
  - verb: void
    pattern: write
  schemas:
    core:
    - Payment
    - Order
    - Customer
    - CatalogObject
    - Location
    - Money
    - Subscription
    - Card
    - Refund
    - Invoice
    - GiftCard
    - Booking
  parameters:
    pagination:
    - cursor
    - limit
    identifiers:
    - location_id
    - customer_id
    - order_id
    - payment_id
    - merchant_id
    filters:
    - begin_time
    - end_time
    - sort_order
    - sort_field
  enums: {}
  authentication:
    schemes:
    - oauth2
    - bearer
    flows:
    - authorizationCode
    versionHeader: Square-Version
capability:
  workflows:
  - name: Square — Apple Pay
    file: capabilities/square-applepay.yaml
    description: Apple Pay.
    toolCount: 1
    domains:
    - Apple Pay
  - name: Square — Bank Accounts
    file: capabilities/square-bankaccounts.yaml
    description: Bank Accounts.
    toolCount: 3
    domains:
    - Bank Accounts
  - name: Square — Booking Custom Attributes
    file: capabilities/square-bookingcustomattributes.yaml
    description: Booking Custom Attributes.
    toolCount: 11
    domains:
    - Booking Custom Attributes
  - name: Square — Bookings
    file: capabilities/square-bookings.yaml
    description: Bookings.
    toolCount: 13
    domains:
    - Bookings
  - name: Square — Cards
    file: capabilities/square-cards.yaml
    description: Cards.
    toolCount: 4
    domains:
    - Cards
  - name: Square — Cash Drawers
    file: capabilities/square-cashdrawers.yaml
    description: Cash Drawers.
    toolCount: 3
    domains:
    - Cash Drawers
  - name: Square — Catalog
    file: capabilities/square-catalog.yaml
    description: Catalog.
    toolCount: 14
    domains:
    - Catalog
  - name: Square — Checkout
    file: capabilities/square-checkout.yaml
    description: Checkout.
    toolCount: 10
    domains:
    - Checkout
  - name: Square — Customer Custom Attributes
    file: capabilities/square-customercustomattributes.yaml
    description: Customer Custom Attributes.
    toolCount: 10
    domains:
    - Customer Custom Attributes
  - name: Square — Customer Groups
    file: capabilities/square-customergroups.yaml
    description: Customer Groups.
    toolCount: 5
    domains:
    - Customer Groups
  - name: Square — Customers
    file: capabilities/square-customers.yaml
    description: Customers.
    toolCount: 14
    domains:
    - Customers
  - name: Square — Customer Segments
    file: capabilities/square-customersegments.yaml
    description: Customer Segments.
    toolCount: 2
    domains:
    - Customer Segments
  - name: Square — Devices
    file: capabilities/square-devices.yaml
    description: Devices.
    toolCount: 5
    domains:
    - Devices
  - name: Square — Disputes
    file: capabilities/square-disputes.yaml
    description: Disputes.
    toolCount: 9
    domains:
    - Disputes
  - name: Square — Employees
    file: capabilities/square-employees.yaml
    description: Employees.
    toolCount: 2
    domains:
    - Employees
  - name: Square — Events
    file: capabilities/square-events.yaml
    description: Events.
    toolCount: 4
    domains:
    - Events
  - name: Square — Gift Card Activities
    file: capabilities/square-giftcardactivities.yaml
    description: Gift Card Activities.
    toolCount: 2
    domains:
    - Gift Card Activities
  - name: Square — Gift Cards
    file: capabilities/square-giftcards.yaml
    description: Gift Cards.
    toolCount: 7
    domains:
    - Gift Cards
  - name: Square — Inventory
    file: capabilities/square-inventory.yaml
    description: Inventory.
    toolCount: 13
    domains:
    - Inventory
  - name: Square — Invoices
    file: capabilities/square-invoices.yaml
    description: Invoices.
    toolCount: 10
    domains:
    - Invoices
  - name: Square — Labor
    file: capabilities/square-labor.yaml
    description: Labor.
    toolCount: 16
    domains:
    - Labor
  - name: Square — Location Custom Attributes
    file: capabilities/square-locationcustomattributes.yaml
    description: Location Custom Attributes.
    toolCount: 11
    domains:
    - Location Custom Attributes
  - name: Square — Locations
    file: capabilities/square-locations.yaml
    description: Locations.
    toolCount: 4
    domains:
    - Locations
  - name: Square — Loyalty
    file: capabilities/square-loyalty.yaml
    description: Loyalty.
    toolCount: 18
    domains:
    - Loyalty
  - name: Square — Merchant Custom Attributes
    file: capabilities/square-merchantcustomattributes.yaml
    description: Merchant Custom Attributes.
    toolCount: 11
    domains:
    - Merchant Custom Attributes
  - name: Square — Merchants
    file: capabilities/square-merchants.yaml
    description: Merchants.
    toolCount: 2
    domains:
    - Merchants
  - name: Square — Mobile Authorization
    file: capabilities/square-mobileauthorization.yaml
    description: Mobile Authorization.
    toolCount: 1
    domains:
    - Mobile Authorization
  - name: Square — OAuth
    file: capabilities/square-oauth.yaml
    description: OAuth.
    toolCount: 3
    domains:
    - OAuth
  - name: Square — Order Custom Attributes
    file: capabilities/square-ordercustomattributes.yaml
    description: Order Custom Attributes.
    toolCount: 11
    domains:
    - Order Custom Attributes
  - name: Square — Orders
    file: capabilities/square-orders.yaml
    description: Orders.
    toolCount: 8
    domains:
    - Orders
  - name: Square — Payments
    file: capabilities/square-payments.yaml
    description: Payments.
    toolCount: 7
    domains:
    - Payments
  - name: Square — Payouts
    file: capabilities/square-payouts.yaml
    description: Payouts.
    toolCount: 3
    domains:
    - Payouts
  - name: Square — Refunds
    file: capabilities/square-refunds.yaml
    description: Refunds.
    toolCount: 3
    domains:
    - Refunds
  - name: Square — Sites
    file: capabilities/square-sites.yaml
    description: Sites.
    toolCount: 1
    domains:
    - Sites
  - name: Square — Snippets
    file: capabilities/square-snippets.yaml
    description: Snippets.
    toolCount: 3
    domains:
    - Snippets
  - name: Square — Subscriptions
    file: capabilities/square-subscriptions.yaml
    description: Subscriptions.
    toolCount: 12
    domains:
    - Subscriptions
  - name: Square — Team
    file: capabilities/square-team.yaml
    description: Team.
    toolCount: 12
    domains:
    - Team
  - name: Square — Terminal
    file: capabilities/square-terminal.yaml
    description: Terminal.
    toolCount: 15
    domains:
    - Terminal
  - name: Square — Transactions
    file: capabilities/square-transactions.yaml
    description: Transactions.
    toolCount: 4
    domains:
    - Transactions
  - name: Square — V1Transactions
    file: capabilities/square-v1transactions.yaml
    description: V1Transactions.
    toolCount: 3
    domains:
    - V1Transactions
  - name: Square — Vendors
    file: capabilities/square-vendors.yaml
    description: Vendors.
    toolCount: 7
    domains:
    - Vendors
  - name: Square — Webhook Subscriptions
    file: capabilities/square-webhooksubscriptions.yaml
    description: Webhook Subscriptions.
    toolCount: 8
    domains:
    - Webhook Subscriptions
  personas:
  - id: seller-developer
    name: Seller Developer
    description: Builds custom commerce apps on a single Square seller account.
  - id: platform-developer
    name: Platform Developer
    description: Builds multi-seller platforms integrating Square via OAuth.
  - id: pos-integrator
    name: POS Integrator
    description: Integrates in-person payments via Terminal, Devices, and Reader SDK.
  - id: restaurant-operator
    name: Restaurant Operator
    description: Runs Square for Restaurants — orders, catalog, labor, and KDS workflows.
  domains:
  - ApplePay
  - BankAccounts
  - BookingCustomAttributes
  - Bookings
  - Cards
  - CashDrawers
  - Catalog
  - Checkout
  - CustomerCustomAttributes
  - CustomerGroups
  - CustomerSegments
  - Customers
  - Devices
  - Disputes
  - Employees
  - Events
  - GiftCardActivities
  - GiftCards
  - Inventory
  - Invoices
  - Labor
  - LocationCustomAttributes
  - Locations
  - Loyalty
  - MerchantCustomAttributes
  - Merchants
  - MobileAuthorization
  - OAuth
  - OrderCustomAttributes
  - Orders
  - Payments
  - Payouts
  - Refunds
  - Sites
  - Snippets
  - Subscriptions
  - Team
  - Terminal
  - Transactions
  - V1Transactions
  - Vendors
  - WebhookSubscriptions
  namespaces:
  - consumed: square-applepay
    rest: square-applepay-rest
    mcp: square-applepay-mcp
  - consumed: square-bankaccounts
    rest: square-bankaccounts-rest
    mcp: square-bankaccounts-mcp
  - consumed: square-bookingcustomattributes
    rest: square-bookingcustomattributes-rest
    mcp: square-bookingcustomattributes-mcp
  - consumed: square-bookings
    rest: square-bookings-rest
    mcp: square-bookings-mcp
  - consumed: square-cards
    rest: square-cards-rest
    mcp: square-cards-mcp
  - consumed: square-cashdrawers
    rest: square-cashdrawers-rest
    mcp: square-cashdrawers-mcp
  - consumed: square-catalog
    rest: square-catalog-rest
    mcp: square-catalog-mcp
  - consumed: square-checkout
    rest: square-checkout-rest
    mcp: square-checkout-mcp
  - consumed: square-customercustomattributes
    rest: square-customercustomattributes-rest
    mcp: square-customercustomattributes-mcp
  - consumed: square-customergroups
    rest: square-customergroups-rest
    mcp: square-customergroups-mcp
  - consumed: square-customers
    rest: square-customers-rest
    mcp: square-customers-mcp
  - consumed: square-customersegments
    rest: square-customersegments-rest
    mcp: square-customersegments-mcp
  - consumed: square-devices
    rest: square-devices-rest
    mcp: square-devices-mcp
  - consumed: square-disputes
    rest: square-disputes-rest
    mcp: square-disputes-mcp
  - consumed: square-employees
    rest: square-employees-rest
    mcp: square-employees-mcp
  - consumed: square-events
    rest: square-events-rest
    mcp: square-events-mcp
  - consumed: square-giftcardactivities
    rest: square-giftcardactivities-rest
    mcp: square-giftcardactivities-mcp
  - consumed: square-giftcards
    rest: square-giftcards-rest
    mcp: square-giftcards-mcp
  - consumed: square-inventory
    rest: square-inventory-rest
    mcp: square-inventory-mcp
  - consumed: square-invoices
    rest: square-invoices-rest
    mcp: square-invoices-mcp
  - consumed: square-labor
    rest: square-labor-rest
    mcp: square-labor-mcp
  - consumed: square-locationcustomattributes
    rest: square-locationcustomattributes-rest
    mcp: square-locationcustomattributes-mcp
  - consumed: square-locations
    rest: square-locations-rest
    mcp: square-locations-mcp
  - consumed: square-loyalty
    rest: square-loyalty-rest
    mcp: square-loyalty-mcp
  - consumed: square-merchantcustomattributes
    rest: square-merchantcustomattributes-rest
    mcp: square-merchantcustomattributes-mcp
  - consumed: square-merchants
    rest: square-merchants-rest
    mcp: square-merchants-mcp
  - consumed: square-mobileauthorization
    rest: square-mobileauthorization-rest
    mcp: square-mobileauthorization-mcp
  - consumed: square-oauth
    rest: square-oauth-rest
    mcp: square-oauth-mcp
  - consumed: square-ordercustomattributes
    rest: square-ordercustomattributes-rest
    mcp: square-ordercustomattributes-mcp
  - consumed: square-orders
    rest: square-orders-rest
    mcp: square-orders-mcp
  - consumed: square-payments
    rest: square-payments-rest
    mcp: square-payments-mcp
  - consumed: square-payouts
    rest: square-payouts-rest
    mcp: square-payouts-mcp
  - consumed: square-refunds
    rest: square-refunds-rest
    mcp: square-refunds-mcp
  - consumed: square-sites
    rest: square-sites-rest
    mcp: square-sites-mcp
  - consumed: square-snippets
    rest: square-snippets-rest
    mcp: square-snippets-mcp
  - consumed: square-subscriptions
    rest: square-subscriptions-rest
    mcp: square-subscriptions-mcp
  - consumed: square-team
    rest: square-team-rest
    mcp: square-team-mcp
  - consumed: square-terminal
    rest: square-terminal-rest
    mcp: square-terminal-mcp
  - consumed: square-transactions
    rest: square-transactions-rest
    mcp: square-transactions-mcp
  - consumed: square-v1transactions
    rest: square-v1transactions-rest
    mcp: square-v1transactions-mcp
  - consumed: square-vendors
    rest: square-vendors-rest
    mcp: square-vendors-mcp
  - consumed: square-webhooksubscriptions
    rest: square-webhooksubscriptions-rest
    mcp: square-webhooksubscriptions-mcp
  binds:
  - env: SQUARE_ACCESS_TOKEN
    usedBy: all capabilities