Shopify API — Payouts

naftiko: 1.0.0-alpha2
info:
  label: Shopify  API — Payouts
  description: 'Shopify  API — Payouts. 6 operations. Lead operation: Shopify Retrieves A List Of All Payouts Ordered By Payout
    Date. Self-contained Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Payouts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopify-payouts
    baseUri: ''
    description: Shopify  API — Payouts business capability. Self-contained, no shared references.
    resources:
    - name: admin-api-2020-01-shopify_payments-payouts.json
      path: /admin/api/2020-01/shopify_payments/payouts.json
      operations:
      - name: deprecated202001getshopifypaymentspayouts
        method: GET
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: since_id
          in: query
          type: string
          description: Filter the response to payouts made after the specified ID.
        - name: last_id
          in: query
          type: string
          description: Filter the response to payouts made before the specified ID.
        - name: date_min
          in: query
          type: string
          description: Filter the response to payouts made inclusively after the specified date.
        - name: date_max
          in: query
          type: string
          description: Filter the response to payouts made inclusively before the specified date.
        - name: date
          in: query
          type: string
          description: Filter the response to payouts made on the specified date.
        - name: status
          in: query
          type: string
          description: Filter the response to payouts made with the specified status.
    - name: admin-api-2020-04-shopify_payments-payouts.json
      path: /admin/api/2020-04/shopify_payments/payouts.json
      operations:
      - name: deprecated202004getshopifypaymentspayouts
        method: GET
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: since_id
          in: query
          type: string
          description: Filter the response to payouts made after the specified ID.
        - name: last_id
          in: query
          type: string
          description: Filter the response to payouts made before the specified ID.
        - name: date_min
          in: query
          type: string
          description: Filter the response to payouts made inclusively after the specified date.
        - name: date_max
          in: query
          type: string
          description: Filter the response to payouts made inclusively before the specified date.
        - name: date
          in: query
          type: string
          description: Filter the response to payouts made on the specified date.
        - name: status
          in: query
          type: string
          description: Filter the response to payouts made with the specified status.
    - name: admin-api-2020-07-shopify_payments-payouts.json
      path: /admin/api/2020-07/shopify_payments/payouts.json
      operations:
      - name: deprecated202007getshopifypaymentspayouts
        method: GET
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: since_id
          in: query
          type: string
          description: Filter the response to payouts made after the specified ID.
        - name: last_id
          in: query
          type: string
          description: Filter the response to payouts made before the specified ID.
        - name: date_min
          in: query
          type: string
          description: Filter the response to payouts made inclusively after the specified date.
        - name: date_max
          in: query
          type: string
          description: Filter the response to payouts made inclusively before the specified date.
        - name: date
          in: query
          type: string
          description: Filter the response to payouts made on the specified date.
        - name: status
          in: query
          type: string
          description: Filter the response to payouts made with the specified status.
    - name: admin-api-2020-10-shopify_payments-payouts.json
      path: /admin/api/2020-10/shopify_payments/payouts.json
      operations:
      - name: getshopifypaymentspayouts
        method: GET
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: since_id
          in: query
          type: string
          description: Filter the response to payouts made after the specified ID.
        - name: last_id
          in: query
          type: string
          description: Filter the response to payouts made before the specified ID.
        - name: date_min
          in: query
          type: string
          description: Filter the response to payouts made inclusively after the specified date.
        - name: date_max
          in: query
          type: string
          description: Filter the response to payouts made inclusively before the specified date.
        - name: date
          in: query
          type: string
          description: Filter the response to payouts made on the specified date.
        - name: status
          in: query
          type: string
          description: Filter the response to payouts made with the specified status.
    - name: admin-api-2021-01-shopify_payments-payouts.json
      path: /admin/api/2021-01/shopify_payments/payouts.json
      operations:
      - name: deprecated202101getshopifypaymentspayouts
        method: GET
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: since_id
          in: query
          type: string
          description: Filter the response to payouts made after the specified ID.
        - name: last_id
          in: query
          type: string
          description: Filter the response to payouts made before the specified ID.
        - name: date_min
          in: query
          type: string
          description: Filter the response to payouts made inclusively after the specified date.
        - name: date_max
          in: query
          type: string
          description: Filter the response to payouts made inclusively before the specified date.
        - name: date
          in: query
          type: string
          description: Filter the response to payouts made on the specified date.
        - name: status
          in: query
          type: string
          description: Filter the response to payouts made with the specified status.
    - name: admin-api-unstable-shopify_payments-payouts.json
      path: /admin/api/unstable/shopify_payments/payouts.json
      operations:
      - name: deprecatedunstablegetshopifypaymentspayouts
        method: GET
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: since_id
          in: query
          type: string
          description: Filter the response to payouts made after the specified ID.
        - name: last_id
          in: query
          type: string
          description: Filter the response to payouts made before the specified ID.
        - name: date_min
          in: query
          type: string
          description: Filter the response to payouts made inclusively after the specified date.
        - name: date_max
          in: query
          type: string
          description: Filter the response to payouts made inclusively before the specified date.
        - name: date
          in: query
          type: string
          description: Filter the response to payouts made on the specified date.
        - name: status
          in: query
          type: string
          description: Filter the response to payouts made with the specified status.
  exposes:
  - type: rest
    namespace: shopify-payouts-rest
    port: 8080
    description: REST adapter for Shopify  API — Payouts. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/admin/api/2020-01/shopify-payments/payouts-json
      name: admin-api-2020-01-shopify-payments-payouts-json
      description: REST surface for admin-api-2020-01-shopify_payments-payouts.json.
      operations:
      - method: GET
        name: deprecated202001getshopifypaymentspayouts
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        call: shopify-payouts.deprecated202001getshopifypaymentspayouts
        with:
          since_id: rest.since_id
          last_id: rest.last_id
          date_min: rest.date_min
          date_max: rest.date_max
          date: rest.date
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-04/shopify-payments/payouts-json
      name: admin-api-2020-04-shopify-payments-payouts-json
      description: REST surface for admin-api-2020-04-shopify_payments-payouts.json.
      operations:
      - method: GET
        name: deprecated202004getshopifypaymentspayouts
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        call: shopify-payouts.deprecated202004getshopifypaymentspayouts
        with:
          since_id: rest.since_id
          last_id: rest.last_id
          date_min: rest.date_min
          date_max: rest.date_max
          date: rest.date
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-07/shopify-payments/payouts-json
      name: admin-api-2020-07-shopify-payments-payouts-json
      description: REST surface for admin-api-2020-07-shopify_payments-payouts.json.
      operations:
      - method: GET
        name: deprecated202007getshopifypaymentspayouts
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        call: shopify-payouts.deprecated202007getshopifypaymentspayouts
        with:
          since_id: rest.since_id
          last_id: rest.last_id
          date_min: rest.date_min
          date_max: rest.date_max
          date: rest.date
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-10/shopify-payments/payouts-json
      name: admin-api-2020-10-shopify-payments-payouts-json
      description: REST surface for admin-api-2020-10-shopify_payments-payouts.json.
      operations:
      - method: GET
        name: getshopifypaymentspayouts
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        call: shopify-payouts.getshopifypaymentspayouts
        with:
          since_id: rest.since_id
          last_id: rest.last_id
          date_min: rest.date_min
          date_max: rest.date_max
          date: rest.date
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2021-01/shopify-payments/payouts-json
      name: admin-api-2021-01-shopify-payments-payouts-json
      description: REST surface for admin-api-2021-01-shopify_payments-payouts.json.
      operations:
      - method: GET
        name: deprecated202101getshopifypaymentspayouts
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        call: shopify-payouts.deprecated202101getshopifypaymentspayouts
        with:
          since_id: rest.since_id
          last_id: rest.last_id
          date_min: rest.date_min
          date_max: rest.date_max
          date: rest.date
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/unstable/shopify-payments/payouts-json
      name: admin-api-unstable-shopify-payments-payouts-json
      description: REST surface for admin-api-unstable-shopify_payments-payouts.json.
      operations:
      - method: GET
        name: deprecatedunstablegetshopifypaymentspayouts
        description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
        call: shopify-payouts.deprecatedunstablegetshopifypaymentspayouts
        with:
          since_id: rest.since_id
          last_id: rest.last_id
          date_min: rest.date_min
          date_max: rest.date_max
          date: rest.date
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shopify-payouts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify  API — Payouts. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: shopify-retrieves-list-all-payouts
      description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-payouts.deprecated202001getshopifypaymentspayouts
      with:
        since_id: tools.since_id
        last_id: tools.last_id
        date_min: tools.date_min
        date_max: tools.date_max
        date: tools.date
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-list-all-payouts-2
      description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-payouts.deprecated202004getshopifypaymentspayouts
      with:
        since_id: tools.since_id
        last_id: tools.last_id
        date_min: tools.date_min
        date_max: tools.date_max
        date: tools.date
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-list-all-payouts-3
      description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-payouts.deprecated202007getshopifypaymentspayouts
      with:
        since_id: tools.since_id
        last_id: tools.last_id
        date_min: tools.date_min
        date_max: tools.date_max
        date: tools.date
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-list-all-payouts-4
      description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-payouts.getshopifypaymentspayouts
      with:
        since_id: tools.since_id
        last_id: tools.last_id
        date_min: tools.date_min
        date_max: tools.date_max
        date: tools.date
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-list-all-payouts-5
      description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-payouts.deprecated202101getshopifypaymentspayouts
      with:
        since_id: tools.since_id
        last_id: tools.last_id
        date_min: tools.date_min
        date_max: tools.date_max
        date: tools.date
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-list-all-payouts-6
      description: Shopify Retrieves A List Of All Payouts Ordered By Payout Date
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-payouts.deprecatedunstablegetshopifypaymentspayouts
      with:
        since_id: tools.since_id
        last_id: tools.last_id
        date_min: tools.date_min
        date_max: tools.date_max
        date: tools.date
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.