Shopify API — Match

naftiko: 1.0.0-alpha2
info:
  label: Shopify  API — Match
  description: 'Shopify  API — Match. 12 operations. Lead operation: Shopify Searches For Customers That Match A Supplied
    Query. Self-contained Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Match
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopify-match
    baseUri: ''
    description: Shopify  API — Match business capability. Self-contained, no shared references.
    resources:
    - name: admin-api-2020-01-customers-search.json
      path: /admin/api/2020-01/customers/search.json
      operations:
      - name: deprecated202001getcustomerssearch
        method: GET
        description: Shopify Searches For Customers That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: Set the field and direction by which to order results.
        - name: query
          in: query
          type: string
          description: Text to search for in the shop's customer data.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2020-01-gift_cards-search.json
      path: /admin/api/2020-01/gift_cards/search.json
      operations:
      - name: deprecated202001getgiftcardssearch
        method: GET
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: The field and direction to order results by.
        - name: query
          in: query
          type: string
          description: The text to search for.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2020-04-customers-search.json
      path: /admin/api/2020-04/customers/search.json
      operations:
      - name: deprecated202004getcustomerssearch
        method: GET
        description: Shopify Searches For Customers That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: Set the field and direction by which to order results.
        - name: query
          in: query
          type: string
          description: Text to search for in the shop's customer data.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2020-04-gift_cards-search.json
      path: /admin/api/2020-04/gift_cards/search.json
      operations:
      - name: deprecated202004getgiftcardssearch
        method: GET
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: The field and direction to order results by.
        - name: query
          in: query
          type: string
          description: The text to search for.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2020-07-customers-search.json
      path: /admin/api/2020-07/customers/search.json
      operations:
      - name: deprecated202007getcustomerssearch
        method: GET
        description: Shopify Searches For Customers That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: Set the field and direction by which to order results.
        - name: query
          in: query
          type: string
          description: Text to search for in the shop's customer data.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2020-07-gift_cards-search.json
      path: /admin/api/2020-07/gift_cards/search.json
      operations:
      - name: deprecated202007getgiftcardssearch
        method: GET
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: The field and direction to order results by.
        - name: query
          in: query
          type: string
          description: The text to search for.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2020-10-customers-search.json
      path: /admin/api/2020-10/customers/search.json
      operations:
      - name: getcustomerssearch
        method: GET
        description: Shopify Searches For Customers That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: Set the field and direction by which to order results.
        - name: query
          in: query
          type: string
          description: Text to search for in the shop's customer data.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2020-10-gift_cards-search.json
      path: /admin/api/2020-10/gift_cards/search.json
      operations:
      - name: getgiftcardssearch
        method: GET
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: The field and direction to order results by.
        - name: query
          in: query
          type: string
          description: The text to search for.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2021-01-customers-search.json
      path: /admin/api/2021-01/customers/search.json
      operations:
      - name: deprecated202101getcustomerssearch
        method: GET
        description: Shopify Searches For Customers That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: Set the field and direction by which to order results.
        - name: query
          in: query
          type: string
          description: Text to search for in the shop's customer data.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-2021-01-gift_cards-search.json
      path: /admin/api/2021-01/gift_cards/search.json
      operations:
      - name: deprecated202101getgiftcardssearch
        method: GET
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: The field and direction to order results by.
        - name: query
          in: query
          type: string
          description: The text to search for.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-unstable-customers-search.json
      path: /admin/api/unstable/customers/search.json
      operations:
      - name: deprecatedunstablegetcustomerssearch
        method: GET
        description: Shopify Searches For Customers That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: Set the field and direction by which to order results.
        - name: query
          in: query
          type: string
          description: Text to search for in the shop's customer data.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to show.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
    - name: admin-api-unstable-gift_cards-search.json
      path: /admin/api/unstable/gift_cards/search.json
      operations:
      - name: deprecatedunstablegetgiftcardssearch
        method: GET
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: The field and direction to order results by.
        - name: query
          in: query
          type: string
          description: The text to search for.
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
  exposes:
  - type: rest
    namespace: shopify-match-rest
    port: 8080
    description: REST adapter for Shopify  API — Match. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/admin/api/2020-01/customers/search-json
      name: admin-api-2020-01-customers-search-json
      description: REST surface for admin-api-2020-01-customers-search.json.
      operations:
      - method: GET
        name: deprecated202001getcustomerssearch
        description: Shopify Searches For Customers That Match A Supplied Query
        call: shopify-match.deprecated202001getcustomerssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-01/gift-cards/search-json
      name: admin-api-2020-01-gift-cards-search-json
      description: REST surface for admin-api-2020-01-gift_cards-search.json.
      operations:
      - method: GET
        name: deprecated202001getgiftcardssearch
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        call: shopify-match.deprecated202001getgiftcardssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-04/customers/search-json
      name: admin-api-2020-04-customers-search-json
      description: REST surface for admin-api-2020-04-customers-search.json.
      operations:
      - method: GET
        name: deprecated202004getcustomerssearch
        description: Shopify Searches For Customers That Match A Supplied Query
        call: shopify-match.deprecated202004getcustomerssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-04/gift-cards/search-json
      name: admin-api-2020-04-gift-cards-search-json
      description: REST surface for admin-api-2020-04-gift_cards-search.json.
      operations:
      - method: GET
        name: deprecated202004getgiftcardssearch
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        call: shopify-match.deprecated202004getgiftcardssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-07/customers/search-json
      name: admin-api-2020-07-customers-search-json
      description: REST surface for admin-api-2020-07-customers-search.json.
      operations:
      - method: GET
        name: deprecated202007getcustomerssearch
        description: Shopify Searches For Customers That Match A Supplied Query
        call: shopify-match.deprecated202007getcustomerssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-07/gift-cards/search-json
      name: admin-api-2020-07-gift-cards-search-json
      description: REST surface for admin-api-2020-07-gift_cards-search.json.
      operations:
      - method: GET
        name: deprecated202007getgiftcardssearch
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        call: shopify-match.deprecated202007getgiftcardssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-10/customers/search-json
      name: admin-api-2020-10-customers-search-json
      description: REST surface for admin-api-2020-10-customers-search.json.
      operations:
      - method: GET
        name: getcustomerssearch
        description: Shopify Searches For Customers That Match A Supplied Query
        call: shopify-match.getcustomerssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-10/gift-cards/search-json
      name: admin-api-2020-10-gift-cards-search-json
      description: REST surface for admin-api-2020-10-gift_cards-search.json.
      operations:
      - method: GET
        name: getgiftcardssearch
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        call: shopify-match.getgiftcardssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2021-01/customers/search-json
      name: admin-api-2021-01-customers-search-json
      description: REST surface for admin-api-2021-01-customers-search.json.
      operations:
      - method: GET
        name: deprecated202101getcustomerssearch
        description: Shopify Searches For Customers That Match A Supplied Query
        call: shopify-match.deprecated202101getcustomerssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2021-01/gift-cards/search-json
      name: admin-api-2021-01-gift-cards-search-json
      description: REST surface for admin-api-2021-01-gift_cards-search.json.
      operations:
      - method: GET
        name: deprecated202101getgiftcardssearch
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        call: shopify-match.deprecated202101getgiftcardssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/unstable/customers/search-json
      name: admin-api-unstable-customers-search-json
      description: REST surface for admin-api-unstable-customers-search.json.
      operations:
      - method: GET
        name: deprecatedunstablegetcustomerssearch
        description: Shopify Searches For Customers That Match A Supplied Query
        call: shopify-match.deprecatedunstablegetcustomerssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/unstable/gift-cards/search-json
      name: admin-api-unstable-gift-cards-search-json
      description: REST surface for admin-api-unstable-gift_cards-search.json.
      operations:
      - method: GET
        name: deprecatedunstablegetgiftcardssearch
        description: Shopify Searches For Gift Cards That Match A Supplied Query
        call: shopify-match.deprecatedunstablegetgiftcardssearch
        with:
          order: rest.order
          query: rest.query
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shopify-match-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify  API — Match. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: shopify-searches-customers-that-match
      description: Shopify Searches For Customers That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecated202001getcustomerssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-gift-cards-that
      description: Shopify Searches For Gift Cards That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecated202001getgiftcardssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-customers-that-match-2
      description: Shopify Searches For Customers That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecated202004getcustomerssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-gift-cards-that-2
      description: Shopify Searches For Gift Cards That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecated202004getgiftcardssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-customers-that-match-3
      description: Shopify Searches For Customers That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecated202007getcustomerssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-gift-cards-that-3
      description: Shopify Searches For Gift Cards That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecated202007getgiftcardssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-customers-that-match-4
      description: Shopify Searches For Customers That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.getcustomerssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-gift-cards-that-4
      description: Shopify Searches For Gift Cards That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.getgiftcardssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-customers-that-match-5
      description: Shopify Searches For Customers That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecated202101getcustomerssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-gift-cards-that-5
      description: Shopify Searches For Gift Cards That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecated202101getgiftcardssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-customers-that-match-6
      description: Shopify Searches For Customers That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecatedunstablegetcustomerssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-searches-gift-cards-that-6
      description: Shopify Searches For Gift Cards That Match A Supplied Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-match.deprecatedunstablegetgiftcardssearch
      with:
        order: tools.order
        query: tools.query
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.