VTex Pricing API — Prices and Fixed Prices

naftiko: 1.0.0-alpha2
info:
  label: VTex Pricing API — Prices and Fixed Prices
  description: 'VTex Pricing API — Prices and Fixed Prices. 8 operations. Lead operation: VTex Get price by SKU ID. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Prices and Fixed Prices
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: pricing-prices-and-fixed-prices
    baseUri: https://api.vtex.com/{accountName}
    description: VTex Pricing API — Prices and Fixed Prices business capability. Self-contained, no shared references.
    resources:
    - name: pricing-prices-itemId
      path: /pricing/prices/{itemId}
      operations:
      - name: getprice
        method: GET
        description: VTex Get price by SKU ID
        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: itemId
          in: path
          type: integer
          description: SKU ID.
          required: true
      - name: deleteprice
        method: DELETE
        description: VTex Delete price all base and fixed prices of an SKU
        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: itemId
          in: path
          type: integer
          description: SKU ID.
          required: true
      - name: createupdatepriceorfixedprice
        method: PUT
        description: VTex Create or update base price or fixed prices
        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: Describes the type of the content being sent.
          required: true
        - name: itemId
          in: path
          type: integer
          description: SKU unique identifier number.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: pricing-prices-itemId-computed-priceTableId
      path: /pricing/prices/{itemId}/computed/{priceTableId}
      operations:
      - name: getcomputedpricebypricetable
        method: GET
        description: VTex Get computed price by price table or trade policy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: categoryIds
          in: query
          type: integer
          description: Category ID.
          required: true
        - name: brandId
          in: query
          type: integer
          description: Brand ID.
          required: true
        - name: quantity
          in: query
          type: integer
          description: SKU quantity.
          required: true
        - 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: itemId
          in: path
          type: integer
          description: SKU ID.
          required: true
        - name: priceTableId
          in: path
          type: string
          description: SKU Price Table Name.
          required: true
    - name: pricing-prices-itemId-fixed
      path: /pricing/prices/{itemId}/fixed
      operations:
      - name: getfixedprices
        method: GET
        description: VTex Get fixed prices
        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: Describes the type of the content being sent.
          required: true
        - name: itemId
          in: path
          type: integer
          description: SKU ID.
          required: true
    - name: pricing-prices-itemId-fixed-priceTableId
      path: /pricing/prices/{itemId}/fixed/{priceTableId}
      operations:
      - name: createorupdatefixedpricesonpricetableortradepolicy
        method: POST
        description: VTex Create or update fixed prices on a price table or trade policy
        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: itemId
          in: path
          type: integer
          description: SKU ID.
          required: true
        - name: priceTableId
          in: path
          type: string
          description: SKU **price table** name or **trade policy** ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getfixedpricesonapricetable
        method: GET
        description: VTex Get fixed prices on a price table or trade policy
        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: itemId
          in: path
          type: integer
          description: SKU ID.
          required: true
        - name: priceTableId
          in: path
          type: string
          description: Price Table Name
          required: true
      - name: deletefixedpricesonapricetableortradepolicy
        method: DELETE
        description: VTex Delete fixed prices on a price table or trade policy
        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: itemId
          in: path
          type: integer
          description: SKU ID.
          required: true
        - name: priceTableId
          in: path
          type: string
          description: Price Table or Trade Policy Name.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: pricing-prices-and-fixed-prices-rest
    port: 8080
    description: REST adapter for VTex Pricing API — Prices and Fixed Prices. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/pricing/prices/{itemid}
      name: pricing-prices-itemid
      description: REST surface for pricing-prices-itemId.
      operations:
      - method: GET
        name: getprice
        description: VTex Get price by SKU ID
        call: pricing-prices-and-fixed-prices.getprice
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          itemId: rest.itemId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteprice
        description: VTex Delete price all base and fixed prices of an SKU
        call: pricing-prices-and-fixed-prices.deleteprice
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          itemId: rest.itemId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: createupdatepriceorfixedprice
        description: VTex Create or update base price or fixed prices
        call: pricing-prices-and-fixed-prices.createupdatepriceorfixedprice
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          itemId: rest.itemId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pricing/prices/{itemid}/computed/{pricetableid}
      name: pricing-prices-itemid-computed-pricetableid
      description: REST surface for pricing-prices-itemId-computed-priceTableId.
      operations:
      - method: GET
        name: getcomputedpricebypricetable
        description: VTex Get computed price by price table or trade policy
        call: pricing-prices-and-fixed-prices.getcomputedpricebypricetable
        with:
          categoryIds: rest.categoryIds
          brandId: rest.brandId
          quantity: rest.quantity
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          itemId: rest.itemId
          priceTableId: rest.priceTableId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pricing/prices/{itemid}/fixed
      name: pricing-prices-itemid-fixed
      description: REST surface for pricing-prices-itemId-fixed.
      operations:
      - method: GET
        name: getfixedprices
        description: VTex Get fixed prices
        call: pricing-prices-and-fixed-prices.getfixedprices
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          itemId: rest.itemId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pricing/prices/{itemid}/fixed/{pricetableid}
      name: pricing-prices-itemid-fixed-pricetableid
      description: REST surface for pricing-prices-itemId-fixed-priceTableId.
      operations:
      - method: POST
        name: createorupdatefixedpricesonpricetableortradepolicy
        description: VTex Create or update fixed prices on a price table or trade policy
        call: pricing-prices-and-fixed-prices.createorupdatefixedpricesonpricetableortradepolicy
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          itemId: rest.itemId
          priceTableId: rest.priceTableId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getfixedpricesonapricetable
        description: VTex Get fixed prices on a price table or trade policy
        call: pricing-prices-and-fixed-prices.getfixedpricesonapricetable
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          itemId: rest.itemId
          priceTableId: rest.priceTableId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletefixedpricesonapricetableortradepolicy
        description: VTex Delete fixed prices on a price table or trade policy
        call: pricing-prices-and-fixed-prices.deletefixedpricesonapricetableortradepolicy
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          itemId: rest.itemId
          priceTableId: rest.priceTableId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: pricing-prices-and-fixed-prices-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Pricing API — Prices and Fixed Prices. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-get-price-sku-id
      description: VTex Get price by SKU ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pricing-prices-and-fixed-prices.getprice
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        itemId: tools.itemId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-price-all-base
      description: VTex Delete price all base and fixed prices of an SKU
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: pricing-prices-and-fixed-prices.deleteprice
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        itemId: tools.itemId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-update-base-price
      description: VTex Create or update base price or fixed prices
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: pricing-prices-and-fixed-prices.createupdatepriceorfixedprice
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        itemId: tools.itemId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-computed-price-price
      description: VTex Get computed price by price table or trade policy
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pricing-prices-and-fixed-prices.getcomputedpricebypricetable
      with:
        categoryIds: tools.categoryIds
        brandId: tools.brandId
        quantity: tools.quantity
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        itemId: tools.itemId
        priceTableId: tools.priceTableId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-fixed-prices
      description: VTex Get fixed prices
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pricing-prices-and-fixed-prices.getfixedprices
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        itemId: tools.itemId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-update-fixed-prices
      description: VTex Create or update fixed prices on a price table or trade policy
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: pricing-prices-and-fixed-prices.createorupdatefixedpricesonpricetableortradepolicy
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        itemId: tools.itemId
        priceTableId: tools.priceTableId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-fixed-prices-price
      description: VTex Get fixed prices on a price table or trade policy
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pricing-prices-and-fixed-prices.getfixedpricesonapricetable
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        itemId: tools.itemId
        priceTableId: tools.priceTableId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-fixed-prices-price
      description: VTex Delete fixed prices on a price table or trade policy
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: pricing-prices-and-fixed-prices.deletefixedpricesonapricetableortradepolicy
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        itemId: tools.itemId
        priceTableId: tools.priceTableId
      outputParameters:
      - type: object
        mapping: $.