VTex Logistics API — Pickup Points

naftiko: 1.0.0-alpha2
info:
  label: VTex Logistics API — Pickup Points
  description: 'VTex Logistics API — Pickup Points. 5 operations. Lead operation: VTex List all pickup points. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Pickup Points
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: logistics-pickup-points
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Logistics API — Pickup Points business capability. Self-contained, no shared references.
    resources:
    - name: api-logistics-pvt-configuration-pickuppoints
      path: /api/logistics/pvt/configuration/pickuppoints
      operations:
      - name: listallpickupppoints
        method: GET
        description: VTex List all pickup points
        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: api-logistics-pvt-configuration-pickuppoints-_search
      path: /api/logistics/pvt/configuration/pickuppoints/_search
      operations:
      - name: getpaged
        method: GET
        description: VTex List paged pickup points
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: string
          required: true
        - name: pageSize
          in: query
          type: string
          required: true
        - name: keyword
          in: query
          type: string
          required: true
        - 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: api-logistics-pvt-configuration-pickuppoints-pickupPointId
      path: /api/logistics/pvt/configuration/pickuppoints/{pickupPointId}
      operations:
      - name: createupdatepickuppoint
        method: PUT
        description: VTex Create/update pickup point
        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: pickupPointId
          in: path
          type: string
          description: Pickup Point ID. Cannot contain spaces.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getbyid
        method: GET
        description: VTex List pickup point by ID
        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: pickupPointId
          in: path
          type: string
          required: true
      - name: delete
        method: DELETE
        description: VTex Delete pickup point
        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: pickupPointId
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: logistics-pickup-points-rest
    port: 8080
    description: REST adapter for VTex Logistics API — Pickup Points. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/logistics/pvt/configuration/pickuppoints
      name: api-logistics-pvt-configuration-pickuppoints
      description: REST surface for api-logistics-pvt-configuration-pickuppoints.
      operations:
      - method: GET
        name: listallpickupppoints
        description: VTex List all pickup points
        call: logistics-pickup-points.listallpickupppoints
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/logistics/pvt/configuration/pickuppoints/search
      name: api-logistics-pvt-configuration-pickuppoints-search
      description: REST surface for api-logistics-pvt-configuration-pickuppoints-_search.
      operations:
      - method: GET
        name: getpaged
        description: VTex List paged pickup points
        call: logistics-pickup-points.getpaged
        with:
          page: rest.page
          pageSize: rest.pageSize
          keyword: rest.keyword
          Content-Type: rest.Content-Type
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/logistics/pvt/configuration/pickuppoints/{pickuppointid}
      name: api-logistics-pvt-configuration-pickuppoints-pickuppointid
      description: REST surface for api-logistics-pvt-configuration-pickuppoints-pickupPointId.
      operations:
      - method: PUT
        name: createupdatepickuppoint
        description: VTex Create/update pickup point
        call: logistics-pickup-points.createupdatepickuppoint
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          pickupPointId: rest.pickupPointId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getbyid
        description: VTex List pickup point by ID
        call: logistics-pickup-points.getbyid
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          pickupPointId: rest.pickupPointId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete pickup point
        call: logistics-pickup-points.delete
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          pickupPointId: rest.pickupPointId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: logistics-pickup-points-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Logistics API — Pickup Points. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-list-all-pickup-points
      description: VTex List all pickup points
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: logistics-pickup-points.listallpickupppoints
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-list-paged-pickup-points
      description: VTex List paged pickup points
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: logistics-pickup-points.getpaged
      with:
        page: tools.page
        pageSize: tools.pageSize
        keyword: tools.keyword
        Content-Type: tools.Content-Type
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-update-pickup-point
      description: VTex Create/update pickup point
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: logistics-pickup-points.createupdatepickuppoint
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        pickupPointId: tools.pickupPointId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-list-pickup-point-id
      description: VTex List pickup point by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: logistics-pickup-points.getbyid
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        pickupPointId: tools.pickupPointId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-pickup-point
      description: VTex Delete pickup point
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: logistics-pickup-points.delete
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        pickupPointId: tools.pickupPointId
      outputParameters:
      - type: object
        mapping: $.