VTex Catalog API — SKU EAN

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — SKU EAN
  description: 'VTex Catalog API — SKU EAN. 5 operations. Lead operation: VTex Get EAN by SKU ID. Self-contained Naftiko capability
    covering one Vtex business surface.'
  tags:
  - Vtex
  - SKU EAN
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-sku-ean
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — SKU EAN business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-stockkeepingunit-skuId-ean
      path: /api/catalog/pvt/stockkeepingunit/{skuId}/ean
      operations:
      - name: get
        method: GET
        description: VTex Get EAN by SKU ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
      - name: delete
        method: DELETE
        description: VTex Delete all SKU EAN values
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
    - name: api-catalog-pvt-stockkeepingunit-skuId-ean-ean
      path: /api/catalog/pvt/stockkeepingunit/{skuId}/ean/{ean}
      operations:
      - name: post
        method: POST
        description: VTex Create SKU EAN
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
        - name: ean
          in: path
          type: string
          description: EAN.
          required: true
      - name: delete
        method: DELETE
        description: VTex Delete SKU EAN
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
        - name: ean
          in: path
          type: string
          description: EAN number.
          required: true
    - name: api-catalog_system-pvt-sku-stockkeepingunitbyean-ean
      path: /api/catalog_system/pvt/sku/stockkeepingunitbyean/{ean}
      operations:
      - name: skubyean
        method: GET
        description: VTex Get SKU by EAN
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ean
          in: path
          type: string
          description: EAN of the SKU which you need to retrieve details from.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-sku-ean-rest
    port: 8080
    description: REST adapter for VTex Catalog API — SKU EAN. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/catalog/pvt/stockkeepingunit/{skuid}/ean
      name: api-catalog-pvt-stockkeepingunit-skuid-ean
      description: REST surface for api-catalog-pvt-stockkeepingunit-skuId-ean.
      operations:
      - method: GET
        name: get
        description: VTex Get EAN by SKU ID
        call: catalog-sku-ean.get
        with:
          skuId: rest.skuId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete all SKU EAN values
        call: catalog-sku-ean.delete
        with:
          skuId: rest.skuId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/stockkeepingunit/{skuid}/ean/{ean}
      name: api-catalog-pvt-stockkeepingunit-skuid-ean-ean
      description: REST surface for api-catalog-pvt-stockkeepingunit-skuId-ean-ean.
      operations:
      - method: POST
        name: post
        description: VTex Create SKU EAN
        call: catalog-sku-ean.post
        with:
          skuId: rest.skuId
          ean: rest.ean
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete SKU EAN
        call: catalog-sku-ean.delete
        with:
          skuId: rest.skuId
          ean: rest.ean
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/sku/stockkeepingunitbyean/{ean}
      name: api-catalog-system-pvt-sku-stockkeepingunitbyean-ean
      description: REST surface for api-catalog_system-pvt-sku-stockkeepingunitbyean-ean.
      operations:
      - method: GET
        name: skubyean
        description: VTex Get SKU by EAN
        call: catalog-sku-ean.skubyean
        with:
          ean: rest.ean
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-sku-ean-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — SKU EAN. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: vtex-get-ean-sku-id
      description: VTex Get EAN by SKU ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-sku-ean.get
      with:
        skuId: tools.skuId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-all-sku-ean
      description: VTex Delete all SKU EAN values
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-ean.delete
      with:
        skuId: tools.skuId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-sku-ean
      description: VTex Create SKU EAN
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-sku-ean.post
      with:
        skuId: tools.skuId
        ean: tools.ean
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-sku-ean
      description: VTex Delete SKU EAN
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-ean.delete
      with:
        skuId: tools.skuId
        ean: tools.ean
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-sku-ean
      description: VTex Get SKU by EAN
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-sku-ean.skubyean
      with:
        ean: tools.ean
      outputParameters:
      - type: object
        mapping: $.