VTex Catalog API — Brand

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Brand
  description: 'VTex Catalog API — Brand. 7 operations. Lead operation: VTex Create brand. Self-contained Naftiko capability
    covering one Vtex business surface.'
  tags:
  - Vtex
  - Brand
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-brand
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Brand business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-brand
      path: /api/catalog/pvt/brand
      operations:
      - name: post
        method: POST
        description: VTex Create brand
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-pvt-brand-brandId
      path: /api/catalog/pvt/brand/{brandId}
      operations:
      - name: get
        method: GET
        description: VTex Get brand and context
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: brandId
          in: path
          type: string
          description: Brand ID.
          required: true
      - name: put
        method: PUT
        description: VTex Update brand
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: brandId
          in: path
          type: string
          description: Brand's unique numerical identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: VTex Delete brand
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: brandId
          in: path
          type: string
          description: Brand's unique numerical identifier.
          required: true
    - name: api-catalog_system-pvt-brand-list
      path: /api/catalog_system/pvt/brand/list
      operations:
      - name: brandlist
        method: GET
        description: VTex Get brand list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-catalog_system-pvt-brand-pagedlist
      path: /api/catalog_system/pvt/brand/pagedlist
      operations:
      - name: brandlistperpage
        method: GET
        description: VTex Get paginated brand list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: pageSize
          in: query
          type: integer
          description: Quantity of brands per page.
          required: true
        - name: page
          in: query
          type: integer
          description: Page number of the brand list.
          required: true
    - name: api-catalog_system-pvt-brand-brandId
      path: /api/catalog_system/pvt/brand/{brandId}
      operations:
      - name: brand
        method: GET
        description: VTex Get brand by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: brandId
          in: path
          type: string
          description: Brand ID.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-brand-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Brand. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/catalog/pvt/brand
      name: api-catalog-pvt-brand
      description: REST surface for api-catalog-pvt-brand.
      operations:
      - method: POST
        name: post
        description: VTex Create brand
        call: catalog-brand.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/brand/{brandid}
      name: api-catalog-pvt-brand-brandid
      description: REST surface for api-catalog-pvt-brand-brandId.
      operations:
      - method: GET
        name: get
        description: VTex Get brand and context
        call: catalog-brand.get
        with:
          brandId: rest.brandId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: VTex Update brand
        call: catalog-brand.put
        with:
          brandId: rest.brandId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete brand
        call: catalog-brand.delete
        with:
          brandId: rest.brandId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/brand/list
      name: api-catalog-system-pvt-brand-list
      description: REST surface for api-catalog_system-pvt-brand-list.
      operations:
      - method: GET
        name: brandlist
        description: VTex Get brand list
        call: catalog-brand.brandlist
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/brand/pagedlist
      name: api-catalog-system-pvt-brand-pagedlist
      description: REST surface for api-catalog_system-pvt-brand-pagedlist.
      operations:
      - method: GET
        name: brandlistperpage
        description: VTex Get paginated brand list
        call: catalog-brand.brandlistperpage
        with:
          pageSize: rest.pageSize
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/brand/{brandid}
      name: api-catalog-system-pvt-brand-brandid
      description: REST surface for api-catalog_system-pvt-brand-brandId.
      operations:
      - method: GET
        name: brand
        description: VTex Get brand by ID
        call: catalog-brand.brand
        with:
          brandId: rest.brandId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-brand-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Brand. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: vtex-create-brand
      description: VTex Create brand
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-brand.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-brand-and-context
      description: VTex Get brand and context
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-brand.get
      with:
        brandId: tools.brandId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-brand
      description: VTex Update brand
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-brand.put
      with:
        brandId: tools.brandId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-brand
      description: VTex Delete brand
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-brand.delete
      with:
        brandId: tools.brandId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-brand-list
      description: VTex Get brand list
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-brand.brandlist
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-paginated-brand-list
      description: VTex Get paginated brand list
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-brand.brandlistperpage
      with:
        pageSize: tools.pageSize
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-brand-id
      description: VTex Get brand by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-brand.brand
      with:
        brandId: tools.brandId
      outputParameters:
      - type: object
        mapping: $.