VTex Logistics API — Warehouses

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