VTex Logistics API — Docks

naftiko: 1.0.0-alpha2
info:
  label: VTex Logistics API — Docks
  description: 'VTex Logistics API — Docks. 6 operations. Lead operation: VTex Create/update dock. Self-contained Naftiko
    capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Docks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: logistics-docks
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Logistics API — Docks business capability. Self-contained, no shared references.
    resources:
    - name: api-logistics-pvt-configuration-docks
      path: /api/logistics/pvt/configuration/docks
      operations:
      - name: createupdatedock
        method: POST
        description: VTex Create/update dock
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: 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: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: alldocks
        method: GET
        description: VTex List all docks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: 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: api-logistics-pvt-configuration-docks-dockId
      path: /api/logistics/pvt/configuration/docks/{dockId}
      operations:
      - name: dockbyid
        method: GET
        description: VTex List dock by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: 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: dockId
          in: path
          type: string
          required: true
      - name: dock
        method: DELETE
        description: VTex Delete dock
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: 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: dockId
          in: path
          type: string
          required: true
    - name: api-logistics-pvt-configuration-docks-dockId-activation
      path: /api/logistics/pvt/configuration/docks/{dockId}/activation
      operations:
      - name: activatedock
        method: POST
        description: VTex Activate dock
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: 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: dockId
          in: path
          type: string
          required: true
    - name: api-logistics-pvt-configuration-docks-dockId-deactivation
      path: /api/logistics/pvt/configuration/docks/{dockId}/deactivation
      operations:
      - name: deactivatedock
        method: POST
        description: VTex Deactivate dock
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: 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: dockId
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: logistics-docks-rest
    port: 8080
    description: REST adapter for VTex Logistics API — Docks. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/logistics/pvt/configuration/docks
      name: api-logistics-pvt-configuration-docks
      description: REST surface for api-logistics-pvt-configuration-docks.
      operations:
      - method: POST
        name: createupdatedock
        description: VTex Create/update dock
        call: logistics-docks.createupdatedock
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: alldocks
        description: VTex List all docks
        call: logistics-docks.alldocks
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/logistics/pvt/configuration/docks/{dockid}
      name: api-logistics-pvt-configuration-docks-dockid
      description: REST surface for api-logistics-pvt-configuration-docks-dockId.
      operations:
      - method: GET
        name: dockbyid
        description: VTex List dock by ID
        call: logistics-docks.dockbyid
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          dockId: rest.dockId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: dock
        description: VTex Delete dock
        call: logistics-docks.dock
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          dockId: rest.dockId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/logistics/pvt/configuration/docks/{dockid}/activation
      name: api-logistics-pvt-configuration-docks-dockid-activation
      description: REST surface for api-logistics-pvt-configuration-docks-dockId-activation.
      operations:
      - method: POST
        name: activatedock
        description: VTex Activate dock
        call: logistics-docks.activatedock
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          dockId: rest.dockId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/logistics/pvt/configuration/docks/{dockid}/deactivation
      name: api-logistics-pvt-configuration-docks-dockid-deactivation
      description: REST surface for api-logistics-pvt-configuration-docks-dockId-deactivation.
      operations:
      - method: POST
        name: deactivatedock
        description: VTex Deactivate dock
        call: logistics-docks.deactivatedock
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          dockId: rest.dockId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: logistics-docks-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Logistics API — Docks. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: vtex-create-update-dock
      description: VTex Create/update dock
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: logistics-docks.createupdatedock
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-list-all-docks
      description: VTex List all docks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: logistics-docks.alldocks
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-list-dock-id
      description: VTex List dock by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: logistics-docks.dockbyid
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        dockId: tools.dockId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-dock
      description: VTex Delete dock
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: logistics-docks.dock
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        dockId: tools.dockId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-activate-dock
      description: VTex Activate dock
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: logistics-docks.activatedock
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        dockId: tools.dockId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-deactivate-dock
      description: VTex Deactivate dock
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: logistics-docks.deactivatedock
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        dockId: tools.dockId
      outputParameters:
      - type: object
        mapping: $.