Etsy Open API v3 — Shop Receipt Transactions

naftiko: 1.0.0-alpha2
info:
  label: Etsy Open API v3 — Shop Receipt Transactions
  description: 'Etsy Open API v3 — Shop Receipt Transactions. 4 operations. Lead operation: Get Shop Receipt Transactions by Listing. Self-contained Naftiko capability covering one Etsy business surface.'
  tags:
    - Etsy
    - Open API v3
    - Shop Receipt Transactions
  created: '2026-05-30'
  modified: '2026-05-30'
binds:
  - namespace: env
    keys:
      ETSY_API_KEY: ETSY_API_KEY
      ETSY_OAUTH_TOKEN: ETSY_OAUTH_TOKEN
capability:
  consumes:
    - type: http
      namespace: open-api-v3-shop-receipt-transactions
      baseUri: https://openapi.etsy.com
      description: Etsy Open API v3 — Shop Receipt Transactions business capability. Self-contained, no shared references.
      authentication:
        type: apikey
        key: x-api-key
        value: '{{env.ETSY_API_KEY}}'
        placement: header
      resources:
        - name: shops-listings-transactions
          path: /v3/application/shops/{shop_id}/listings/{listing_id}/transactions
          operations:
            - name: getShopReceiptTransactionsByListing
              method: GET
              description: Get Shop Receipt Transactions by Listing
              inputParameters:
                - name: shop_id
                  in: path
                  type: integer
                  required: true
                  description: The unique positive non-zero numeric ID for an Etsy Shop.
                - name: listing_id
                  in: path
                  type: integer
                  required: true
                  description: The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
                - name: limit
                  in: query
                  type: integer
                  required: false
                  description: The maximum number of results to return.
                - name: offset
                  in: query
                  type: integer
                  required: false
                  description: The number of records to skip before selecting the first result.
                - name: legacy
                  in: query
                  type: boolean
                  required: false
                  description: This parameter needed to enable new parameters and response values related to processing profiles.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: shops-receipts-transactions
          path: /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions
          operations:
            - name: getShopReceiptTransactionsByReceipt
              method: GET
              description: Get Shop Receipt Transactions by Receipt
              inputParameters:
                - name: shop_id
                  in: path
                  type: integer
                  required: true
                  description: The unique positive non-zero numeric ID for an Etsy Shop.
                - name: receipt_id
                  in: path
                  type: integer
                  required: true
                  description: The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
                - name: legacy
                  in: query
                  type: boolean
                  required: false
                  description: This parameter needed to enable new parameters and response values related to processing profiles.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: shops-transactions
          path: /v3/application/shops/{shop_id}/transactions/{transaction_id}
          operations:
            - name: getShopReceiptTransaction
              method: GET
              description: Get Shop Receipt Transaction
              inputParameters:
                - name: shop_id
                  in: path
                  type: integer
                  required: true
                  description: The unique positive non-zero numeric ID for an Etsy Shop.
                - name: transaction_id
                  in: path
                  type: integer
                  required: true
                  description: The unique numeric ID for a transaction.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: shops-transactions
          path: /v3/application/shops/{shop_id}/transactions
          operations:
            - name: getShopReceiptTransactionsByShop
              method: GET
              description: Get Shop Receipt Transactions by Shop
              inputParameters:
                - name: shop_id
                  in: path
                  type: integer
                  required: true
                  description: The unique positive non-zero numeric ID for an Etsy Shop.
                - name: limit
                  in: query
                  type: integer
                  required: false
                  description: The maximum number of results to return.
                - name: offset
                  in: query
                  type: integer
                  required: false
                  description: The number of records to skip before selecting the first result.
                - name: legacy
                  in: query
                  type: boolean
                  required: false
                  description: This parameter needed to enable new parameters and response values related to processing profiles.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
  exposes:
    - type: rest
      namespace: open-api-v3-shop-receipt-transactions-rest
      port: 8080
      description: REST adapter for Etsy Open API v3 — Shop Receipt Transactions. One Spectral-compliant resource per consumed operation, prefixed with /v1.
      resources:
        - path: /v1/shops/{shop_id}/listings/{listing_id}/transactions
          name: shops-listings-transactions
          description: REST surface for shops-listings-transactions.
          operations:
            - method: GET
              name: getShopReceiptTransactionsByListing
              description: Get Shop Receipt Transactions by Listing
              call: open-api-v3-shop-receipt-transactions.getShopReceiptTransactionsByListing
              with:
                shop_id: rest.shop_id
                listing_id: rest.listing_id
                limit: rest.limit
                offset: rest.offset
                legacy: rest.legacy
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/shops/{shop_id}/receipts/{receipt_id}/transactions
          name: shops-receipts-transactions
          description: REST surface for shops-receipts-transactions.
          operations:
            - method: GET
              name: getShopReceiptTransactionsByReceipt
              description: Get Shop Receipt Transactions by Receipt
              call: open-api-v3-shop-receipt-transactions.getShopReceiptTransactionsByReceipt
              with:
                shop_id: rest.shop_id
                receipt_id: rest.receipt_id
                legacy: rest.legacy
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/shops/{shop_id}/transactions/{transaction_id}
          name: shops-transactions
          description: REST surface for shops-transactions.
          operations:
            - method: GET
              name: getShopReceiptTransaction
              description: Get Shop Receipt Transaction
              call: open-api-v3-shop-receipt-transactions.getShopReceiptTransaction
              with:
                shop_id: rest.shop_id
                transaction_id: rest.transaction_id
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/shops/{shop_id}/transactions
          name: shops-transactions
          description: REST surface for shops-transactions.
          operations:
            - method: GET
              name: getShopReceiptTransactionsByShop
              description: Get Shop Receipt Transactions by Shop
              call: open-api-v3-shop-receipt-transactions.getShopReceiptTransactionsByShop
              with:
                shop_id: rest.shop_id
                limit: rest.limit
                offset: rest.offset
                legacy: rest.legacy
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: open-api-v3-shop-receipt-transactions-mcp
      port: 9090
      transport: http
      description: MCP adapter for Etsy Open API v3 — Shop Receipt Transactions. One tool per consumed operation, routed inline through this capability's consumes block.
      tools:
        - name: get-shop-receipt-transactions-listing
          description: Get Shop Receipt Transactions by Listing
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: open-api-v3-shop-receipt-transactions.getShopReceiptTransactionsByListing
          with:
            shop_id: tools.shop_id
            listing_id: tools.listing_id
            limit: tools.limit
            offset: tools.offset
            legacy: tools.legacy
          outputParameters:
            - type: object
              mapping: $.
        - name: get-shop-receipt-transactions-receipt
          description: Get Shop Receipt Transactions by Receipt
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: open-api-v3-shop-receipt-transactions.getShopReceiptTransactionsByReceipt
          with:
            shop_id: tools.shop_id
            receipt_id: tools.receipt_id
            legacy: tools.legacy
          outputParameters:
            - type: object
              mapping: $.
        - name: get-shop-receipt-transaction
          description: Get Shop Receipt Transaction
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: open-api-v3-shop-receipt-transactions.getShopReceiptTransaction
          with:
            shop_id: tools.shop_id
            transaction_id: tools.transaction_id
          outputParameters:
            - type: object
              mapping: $.
        - name: get-shop-receipt-transactions-shop
          description: Get Shop Receipt Transactions by Shop
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: open-api-v3-shop-receipt-transactions.getShopReceiptTransactionsByShop
          with:
            shop_id: tools.shop_id
            limit: tools.limit
            offset: tools.offset
            legacy: tools.legacy
          outputParameters:
            - type: object
              mapping: $.