VTex Pricing API — Price Tables

naftiko: 1.0.0-alpha2
info:
  label: VTex Pricing API — Price Tables
  description: 'VTex Pricing API — Price Tables. 4 operations. Lead operation: VTex Get all price tables and their rules.
    Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Price Tables
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: pricing-price-tables
    baseUri: https://api.vtex.com/{accountName}
    description: VTex Pricing API — Price Tables business capability. Self-contained, no shared references.
    resources:
    - name: pricing-pipeline-catalog
      path: /pricing/pipeline/catalog
      operations:
      - name: getallpricetablesandrules
        method: GET
        description: VTex Get all price tables and their rules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: Describes the 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: pricing-pipeline-catalog-priceTableId
      path: /pricing/pipeline/catalog/{priceTableId}
      operations:
      - name: getrulesforapricetable
        method: GET
        description: VTex Get rules for a price table
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: Describes the 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: priceTableId
          in: path
          type: string
          description: Price Table Name.
          required: true
      - name: put
        method: PUT
        description: VTex Update rules for a price table
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: Describes the 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: priceTableId
          in: path
          type: string
          description: Price Table Name.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: pricing-tables
      path: /pricing/tables
      operations:
      - name: listpricetables
        method: GET
        description: VTex List price tables
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: Describes the 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
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: pricing-price-tables-rest
    port: 8080
    description: REST adapter for VTex Pricing API — Price Tables. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/pricing/pipeline/catalog
      name: pricing-pipeline-catalog
      description: REST surface for pricing-pipeline-catalog.
      operations:
      - method: GET
        name: getallpricetablesandrules
        description: VTex Get all price tables and their rules
        call: pricing-price-tables.getallpricetablesandrules
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pricing/pipeline/catalog/{pricetableid}
      name: pricing-pipeline-catalog-pricetableid
      description: REST surface for pricing-pipeline-catalog-priceTableId.
      operations:
      - method: GET
        name: getrulesforapricetable
        description: VTex Get rules for a price table
        call: pricing-price-tables.getrulesforapricetable
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          priceTableId: rest.priceTableId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: VTex Update rules for a price table
        call: pricing-price-tables.put
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          priceTableId: rest.priceTableId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pricing/tables
      name: pricing-tables
      description: REST surface for pricing-tables.
      operations:
      - method: GET
        name: listpricetables
        description: VTex List price tables
        call: pricing-price-tables.listpricetables
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: pricing-price-tables-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Pricing API — Price Tables. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: vtex-get-all-price-tables
      description: VTex Get all price tables and their rules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pricing-price-tables.getallpricetablesandrules
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-rules-price-table
      description: VTex Get rules for a price table
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pricing-price-tables.getrulesforapricetable
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        priceTableId: tools.priceTableId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-rules-price-table
      description: VTex Update rules for a price table
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: pricing-price-tables.put
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        priceTableId: tools.priceTableId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-list-price-tables
      description: VTex List price tables
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pricing-price-tables.listpricetables
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.