VTex Suggestions — Match Received SKUs

naftiko: 1.0.0-alpha2
info:
  label: VTex Suggestions — Match Received SKUs
  description: 'VTex Suggestions — Match Received SKUs. 2 operations. Lead operation: VTex Match Multiple Received SKUs. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Match Received SKUs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: suggestions-match-received-skus
    baseUri: https://api.vtex.com/{accountName}
    description: VTex Suggestions — Match Received SKUs business capability. Self-contained, no shared references.
    resources:
    - name: suggestions-matches-action-actionName
      path: /suggestions/matches/action/{actionName}
      operations:
      - name: matchmultiple
        method: PUT
        description: VTex Match Multiple Received SKUs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountName
          in: path
          type: string
          description: Name of the VTEX account. Used as part of the URL
          required: true
        - name: Content-Type
          in: header
          type: string
          description: Describes the type of the content being sent.
          required: true
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
          required: true
        - name: actionName
          in: path
          type: string
          description: 'Operation to apply to received SKUs. Possible values include: '
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: suggestions-sellerId-sellerskuid-versions-version-matches-matchid
      path: /suggestions/{sellerId}/{sellerskuid}/versions/{version}/matches/{matchid}
      operations:
      - name: match
        method: PUT
        description: VTex Match Received SKUs individually
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountName
          in: path
          type: string
          description: Name of the VTEX account. Used as part of the URL
          required: true
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
          required: true
        - name: Content-Type
          in: header
          type: string
          description: Describes the type of the content being sent.
          required: true
        - name: sellerId
          in: path
          type: string
          description: A string that identifies the seller in the marketplace. This ID must be created by the marketplace
            and informed to the seller before the integration is built.
          required: true
        - name: sellerskuid
          in: path
          type: string
          description: A string that identifies the SKU in the marketplace. This is the ID that the marketplace will use for
            future references to this SKU, such as price and inventory
          required: true
        - name: version
          in: path
          type: string
          description: Whenever an SKU Suggestion is updated or changed, a new version of the original one is created. All
            versions are logged, so you can search for previous our curr
          required: true
        - name: matchid
          in: path
          type: string
          description: 'Whenever an SKU suggestion is matched, it is associated to a unique ID. Fill in this field with the
            matchId you wish to filter by. The `matchId`''s value can be '
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: suggestions-match-received-skus-rest
    port: 8080
    description: REST adapter for VTex Suggestions — Match Received SKUs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/suggestions/matches/action/{actionname}
      name: suggestions-matches-action-actionname
      description: REST surface for suggestions-matches-action-actionName.
      operations:
      - method: PUT
        name: matchmultiple
        description: VTex Match Multiple Received SKUs
        call: suggestions-match-received-skus.matchmultiple
        with:
          accountName: rest.accountName
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          actionName: rest.actionName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/suggestions/{sellerid}/{sellerskuid}/versions/{version}/matches/{matchid}
      name: suggestions-sellerid-sellerskuid-versions-version-matches-matchid
      description: REST surface for suggestions-sellerId-sellerskuid-versions-version-matches-matchid.
      operations:
      - method: PUT
        name: match
        description: VTex Match Received SKUs individually
        call: suggestions-match-received-skus.match
        with:
          accountName: rest.accountName
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          sellerId: rest.sellerId
          sellerskuid: rest.sellerskuid
          version: rest.version
          matchid: rest.matchid
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: suggestions-match-received-skus-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Suggestions — Match Received SKUs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-match-multiple-received-skus
      description: VTex Match Multiple Received SKUs
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: suggestions-match-received-skus.matchmultiple
      with:
        accountName: tools.accountName
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        actionName: tools.actionName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-match-received-skus-individually
      description: VTex Match Received SKUs individually
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: suggestions-match-received-skus.match
      with:
        accountName: tools.accountName
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        sellerId: tools.sellerId
        sellerskuid: tools.sellerskuid
        version: tools.version
        matchid: tools.matchid
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.