VTex Logistics API — Shipping Policies

naftiko: 1.0.0-alpha2
info:
  label: VTex Logistics API — Shipping Policies
  description: 'VTex Logistics API — Shipping Policies. 5 operations. Lead operation: VTex List shipping policies. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Shipping Policies
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: logistics-shipping-policies
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Logistics API — Shipping Policies business capability. Self-contained, no shared references.
    resources:
    - name: api-logistics-pvt-shipping-policies
      path: /api/logistics/pvt/shipping-policies
      operations:
      - name: get
        method: GET
        description: VTex List shipping policies
        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: Type of the content being sent.
          required: true
        - name: page
          in: query
          type: string
          description: Desired number of pages to retrieve information from your Shipping Policies.
          required: true
        - name: perPage
          in: query
          type: string
          description: Desired number of items per page, to retrieve information from your Shipping Policies.
          required: true
      - name: post
        method: POST
        description: VTex Create shipping policy
        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: Type of the content being sent.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-logistics-pvt-shipping-policies-id
      path: /api/logistics/pvt/shipping-policies/{id}
      operations:
      - name: get
        method: GET
        description: VTex Retrieve shipping policy by ID
        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: Type of the content being sent.
          required: true
        - name: id
          in: path
          type: string
          description: ID of the shipping policy.
          required: true
      - name: delete
        method: DELETE
        description: VTex Delete shipping policies by ID
        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: Type of the content being sent.
          required: true
        - name: id
          in: path
          type: string
          description: ID of the shipping policy.
          required: true
      - name: put
        method: PUT
        description: VTex Update shipping policy
        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: Type of the content being sent.
          required: true
        - name: id
          in: path
          type: string
          description: Shipping policy's ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: logistics-shipping-policies-rest
    port: 8080
    description: REST adapter for VTex Logistics API — Shipping Policies. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/logistics/pvt/shipping-policies
      name: api-logistics-pvt-shipping-policies
      description: REST surface for api-logistics-pvt-shipping-policies.
      operations:
      - method: GET
        name: get
        description: VTex List shipping policies
        call: logistics-shipping-policies.get
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: VTex Create shipping policy
        call: logistics-shipping-policies.post
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/logistics/pvt/shipping-policies/{id}
      name: api-logistics-pvt-shipping-policies-id
      description: REST surface for api-logistics-pvt-shipping-policies-id.
      operations:
      - method: GET
        name: get
        description: VTex Retrieve shipping policy by ID
        call: logistics-shipping-policies.get
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete shipping policies by ID
        call: logistics-shipping-policies.delete
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: VTex Update shipping policy
        call: logistics-shipping-policies.put
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: logistics-shipping-policies-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Logistics API — Shipping Policies. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-list-shipping-policies
      description: VTex List shipping policies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: logistics-shipping-policies.get
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-shipping-policy
      description: VTex Create shipping policy
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: logistics-shipping-policies.post
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-retrieve-shipping-policy-id
      description: VTex Retrieve shipping policy by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: logistics-shipping-policies.get
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-shipping-policies-id
      description: VTex Delete shipping policies by ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: logistics-shipping-policies.delete
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-shipping-policy
      description: VTex Update shipping policy
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: logistics-shipping-policies.put
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.