VTex Checkout API — Region

naftiko: 1.0.0-alpha2
info:
  label: VTex Checkout API — Region
  description: 'VTex Checkout API — Region. 1 operations. Lead operation: VTex Get sellers by region or address. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Region
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: checkout-region
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Checkout API — Region business capability. Self-contained, no shared references.
    resources:
    - name: api-checkout-pub-regions-regionId
      path: /api/checkout/pub/regions/{regionId}
      operations:
      - name: getsellersbyregion
        method: GET
        description: VTex Get sellers by region or address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: regionId
          in: path
          type: string
          description: ID of the region corresponding to the shopper's location.
          required: true
        - name: country
          in: query
          type: string
          description: Three letter country code refering to the `postalCode` field.
          required: true
        - name: postalCode
          in: query
          type: string
          description: Postal code corresponding to the shopper's location.
        - name: geoCoordinates
          in: query
          type: array
          description: Geocoordinates (first longitude, semicolon, then latitude) corresponding to the shopper's location.
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: checkout-region-rest
    port: 8080
    description: REST adapter for VTex Checkout API — Region. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/checkout/pub/regions/{regionid}
      name: api-checkout-pub-regions-regionid
      description: REST surface for api-checkout-pub-regions-regionId.
      operations:
      - method: GET
        name: getsellersbyregion
        description: VTex Get sellers by region or address
        call: checkout-region.getsellersbyregion
        with:
          regionId: rest.regionId
          country: rest.country
          postalCode: rest.postalCode
          geoCoordinates: rest.geoCoordinates
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: checkout-region-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Checkout API — Region. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: vtex-get-sellers-region-address
      description: VTex Get sellers by region or address
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: checkout-region.getsellersbyregion
      with:
        regionId: tools.regionId
        country: tools.country
        postalCode: tools.postalCode
        geoCoordinates: tools.geoCoordinates
      outputParameters:
      - type: object
        mapping: $.