VTex Buyer Organizations — Bulk Import

naftiko: 1.0.0-alpha2
info:
  label: VTex Buyer Organizations — Bulk Import
  description: 'VTex Buyer Organizations — Bulk Import. 4 operations. Lead operation: VTex Upload file. Self-contained Naftiko
    capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Bulk Import
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: buyer-organization-bulk-import
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Buyer Organizations — Bulk Import business capability. Self-contained, no shared references.
    resources:
    - name: api-b2b-import-buyer-orgs
      path: /api/b2b/import/buyer-orgs
      operations:
      - name: uploadfile
        method: POST
        description: VTex Upload file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-b2b-import-buyer-orgs-validate-importId
      path: /api/b2b/import/buyer-orgs/validate/{importId}
      operations:
      - name: validatefile
        method: POST
        description: VTex Validate file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-b2b-import-buyer-orgs-importId
      path: /api/b2b/import/buyer-orgs/{importId}
      operations:
      - name: checkprogress
        method: GET
        description: VTex Check progress
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: VTex Start import
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: buyer-organization-bulk-import-rest
    port: 8080
    description: REST adapter for VTex Buyer Organizations — Bulk Import. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/b2b/import/buyer-orgs
      name: api-b2b-import-buyer-orgs
      description: REST surface for api-b2b-import-buyer-orgs.
      operations:
      - method: POST
        name: uploadfile
        description: VTex Upload file
        call: buyer-organization-bulk-import.uploadfile
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/b2b/import/buyer-orgs/validate/{importid}
      name: api-b2b-import-buyer-orgs-validate-importid
      description: REST surface for api-b2b-import-buyer-orgs-validate-importId.
      operations:
      - method: POST
        name: validatefile
        description: VTex Validate file
        call: buyer-organization-bulk-import.validatefile
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/b2b/import/buyer-orgs/{importid}
      name: api-b2b-import-buyer-orgs-importid
      description: REST surface for api-b2b-import-buyer-orgs-importId.
      operations:
      - method: GET
        name: checkprogress
        description: VTex Check progress
        call: buyer-organization-bulk-import.checkprogress
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: VTex Start import
        call: buyer-organization-bulk-import.post
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: buyer-organization-bulk-import-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Buyer Organizations — Bulk Import. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-upload-file
      description: VTex Upload file
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: buyer-organization-bulk-import.uploadfile
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-validate-file
      description: VTex Validate file
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: buyer-organization-bulk-import.validatefile
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-check-progress
      description: VTex Check progress
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: buyer-organization-bulk-import.checkprogress
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-start-import
      description: VTex Start import
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: buyer-organization-bulk-import.post
      outputParameters:
      - type: object
        mapping: $.