VTex Suggestions — Get Suggestions

naftiko: 1.0.0-alpha2
info:
  label: VTex Suggestions — Get Suggestions
  description: 'VTex Suggestions — Get Suggestions. 2 operations. Lead operation: VTex Get all SKU suggestions. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Get Suggestions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: suggestions-get-suggestions
    baseUri: https://api.vtex.com/{accountName}
    description: VTex Suggestions — Get Suggestions business capability. Self-contained, no shared references.
    resources:
    - name: suggestions
      path: /suggestions
      operations:
      - name: getsuggestions
        method: GET
        description: VTex Get all SKU suggestions
        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: q
          in: query
          type: string
          description: 'This field allows you to customize your search. You can fill in this query param if you want to narrow
            down your search using the available filters on Received '
        - name: type
          in: query
          type: string
          description: This field allows users to filter SKU suggestions, by searching only the new suggestions that were
            just sent, and suggestions that have already been sent, but w
        - name: seller
          in: query
          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 so it can call this endpoint.
        - name: status
          in: query
          type: string
          description: 'Narrow down you search, filtering by status. Values allowed on this field include: `accepted`, `pending`
            and `denied.`'
        - name: hasmapping
          in: query
          type: string
          description: This field allows you to filter SKUs that have mapping or not. Insert `true` to filter SKUs that have
            mapping, or `false` to retrieve SKUs that aren't mapped.
        - name: matcherid
          in: query
          type: string
          description: Identifies the matching entity. It can be either VTEX's matcher, or an external matcher developed by
            partners, for example. The `matcherId`'s value can be obtai
        - name: _from
          in: query
          type: integer
          description: Define your pagination range, by adding the pagination starting value. Values should be bigger than
            0, with a maximum of 50 records per page.
        - name: _to
          in: query
          type: integer
          description: Define your pagination range, by adding the pagination ending value. Values should be bigger than 0,
            with a maximum of 50 records per page.
        - 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: Type of the content being sent.
          required: true
    - name: suggestions-sellerId-sellerSkuId
      path: /suggestions/{sellerId}/{sellerSkuId}
      operations:
      - name: getsuggestion
        method: GET
        description: VTex Get SKU Suggestion by ID
        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
  exposes:
  - type: rest
    namespace: suggestions-get-suggestions-rest
    port: 8080
    description: REST adapter for VTex Suggestions — Get Suggestions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/suggestions
      name: suggestions
      description: REST surface for suggestions.
      operations:
      - method: GET
        name: getsuggestions
        description: VTex Get all SKU suggestions
        call: suggestions-get-suggestions.getsuggestions
        with:
          accountName: rest.accountName
          q: rest.q
          type: rest.type
          seller: rest.seller
          status: rest.status
          hasmapping: rest.hasmapping
          matcherid: rest.matcherid
          _from: rest._from
          _to: rest._to
          Accept: rest.Accept
          Content-Type: rest.Content-Type
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/suggestions/{sellerid}/{sellerskuid}
      name: suggestions-sellerid-sellerskuid
      description: REST surface for suggestions-sellerId-sellerSkuId.
      operations:
      - method: GET
        name: getsuggestion
        description: VTex Get SKU Suggestion by ID
        call: suggestions-get-suggestions.getsuggestion
        with:
          accountName: rest.accountName
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          sellerId: rest.sellerId
          sellerSkuId: rest.sellerSkuId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: suggestions-get-suggestions-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Suggestions — Get Suggestions. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-get-all-sku-suggestions
      description: VTex Get all SKU suggestions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: suggestions-get-suggestions.getsuggestions
      with:
        accountName: tools.accountName
        q: tools.q
        type: tools.type
        seller: tools.seller
        status: tools.status
        hasmapping: tools.hasmapping
        matcherid: tools.matcherid
        _from: tools._from
        _to: tools._to
        Accept: tools.Accept
        Content-Type: tools.Content-Type
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-sku-suggestion-id
      description: VTex Get SKU Suggestion by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: suggestions-get-suggestions.getsuggestion
      with:
        accountName: tools.accountName
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        sellerId: tools.sellerId
        sellerSkuId: tools.sellerSkuId
      outputParameters:
      - type: object
        mapping: $.