VTex Logistics API — Freight Values

naftiko: 1.0.0-alpha2
info:
  label: VTex Logistics API — Freight Values
  description: 'VTex Logistics API — Freight Values. 2 operations. Lead operation: VTex Create/update freight values. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Freight Values
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: logistics-freight-values
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Logistics API — Freight Values business capability. Self-contained, no shared references.
    resources:
    - name: api-logistics-pvt-configuration-freights-carrierId-values-update
      path: /api/logistics/pvt/configuration/freights/{carrierId}/values/update
      operations:
      - name: createupdatefreightvalues
        method: POST
        description: VTex Create/update freight values
        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: carrierId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-logistics-pvt-configuration-freights-carrierId-cep-values
      path: /api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values
      operations:
      - name: freightvalues
        method: GET
        description: VTex List freight values
        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: carrierId
          in: path
          type: string
          description: Carrier ID
          required: true
        - name: cep
          in: path
          type: string
          description: Postal code.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: logistics-freight-values-rest
    port: 8080
    description: REST adapter for VTex Logistics API — Freight Values. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/logistics/pvt/configuration/freights/{carrierid}/values/update
      name: api-logistics-pvt-configuration-freights-carrierid-values-update
      description: REST surface for api-logistics-pvt-configuration-freights-carrierId-values-update.
      operations:
      - method: POST
        name: createupdatefreightvalues
        description: VTex Create/update freight values
        call: logistics-freight-values.createupdatefreightvalues
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          carrierId: rest.carrierId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/logistics/pvt/configuration/freights/{carrierid}/{cep}/values
      name: api-logistics-pvt-configuration-freights-carrierid-cep-values
      description: REST surface for api-logistics-pvt-configuration-freights-carrierId-cep-values.
      operations:
      - method: GET
        name: freightvalues
        description: VTex List freight values
        call: logistics-freight-values.freightvalues
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          carrierId: rest.carrierId
          cep: rest.cep
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: logistics-freight-values-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Logistics API — Freight Values. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-create-update-freight-values
      description: VTex Create/update freight values
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: logistics-freight-values.createupdatefreightvalues
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        carrierId: tools.carrierId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-list-freight-values
      description: VTex List freight values
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: logistics-freight-values.freightvalues
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        carrierId: tools.carrierId
        cep: tools.cep
      outputParameters:
      - type: object
        mapping: $.