VTex Orders API — Change Order (Beta)

naftiko: 1.0.0-alpha2
info:
  label: VTex Orders API — Change Order (Beta)
  description: 'VTex Orders API — Change Order (Beta). 6 operations. Lead operation: VTex Create order change. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Change Order (Beta)
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: orders-change-order-beta
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Orders API — Change Order (Beta) business capability. Self-contained, no shared references.
    resources:
    - name: api-order-system-orders-changeOrderId-changes
      path: /api/order-system/orders/{changeOrderId}/changes
      operations:
      - name: createchange
        method: PATCH
        description: VTex Create order change
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: an
          in: query
          type: string
          description: Name of the VTEX account that created the order.
          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: changeOrderId
          in: path
          type: string
          description: Order ID of the order you wish to change.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getchangehistory
        method: GET
        description: VTex Get order change history
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: an
          in: query
          type: string
          description: Name of the VTEX account that created the order.
          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: changeOrderId
          in: path
          type: string
          description: Order ID of the order you wish to get the change history.
          required: true
    - name: api-order-system-orders-changeOrderId-changes-preview
      path: /api/order-system/orders/{changeOrderId}/changes/preview
      operations:
      - name: previewchange
        method: POST
        description: VTex Preview order change
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: an
          in: query
          type: string
          description: Name of the VTEX account that created the order.
          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: changeOrderId
          in: path
          type: string
          description: Order ID of the order you wish to preview change.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-order-system-orders-changeOrderId-changes-changeRequestId
      path: /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}
      operations:
      - name: getchangedetail
        method: GET
        description: VTex Get order change details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: an
          in: query
          type: string
          description: Name of the VTEX account that created the order.
          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: changeOrderId
          in: path
          type: string
          description: Order ID of the order you wish to get the change detail.
          required: true
        - name: changeRequestId
          in: path
          type: string
          description: Once you make an order change, you generate a `requestId` code that identifies the changes made to
            that order. This field should be filled with that code. There
          required: true
    - name: api-order-system-orders-changeOrderId-changes-changeRequestId-cancel
      path: /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel
      operations:
      - name: cancelchangestoppedonerror
        method: POST
        description: VTex Cancel order change
        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: an
          in: query
          type: string
          description: Name of the VTEX account that created the order.
          required: true
        - name: changeOrderId
          in: path
          type: string
          description: Order ID of the order with the changes you wish to cancel.
          required: true
        - name: changeRequestId
          in: path
          type: string
          description: Once you make an order change, you generate a `requestId` code that identifies the changes made to
            that order. This field should be filled with that code. After
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-order-system-orders-changeOrderId-changes-changeRequestId-retry
      path: /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry
      operations:
      - name: retrychange
        method: POST
        description: VTex Retry order change
        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: an
          in: query
          type: string
          description: Name of the VTEX account that created the order.
          required: true
        - name: changeOrderId
          in: path
          type: string
          description: Order ID of the order you wish to retry change.
          required: true
        - name: changeRequestId
          in: path
          type: string
          description: "Once you make an order change, you generate a `requestId` code that identifies the changes made to\
            \ that order. This field should be filled with that code.\r"
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: orders-change-order-beta-rest
    port: 8080
    description: REST adapter for VTex Orders API — Change Order (Beta). One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/order-system/orders/{changeorderid}/changes
      name: api-order-system-orders-changeorderid-changes
      description: REST surface for api-order-system-orders-changeOrderId-changes.
      operations:
      - method: PATCH
        name: createchange
        description: VTex Create order change
        call: orders-change-order-beta.createchange
        with:
          an: rest.an
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          changeOrderId: rest.changeOrderId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getchangehistory
        description: VTex Get order change history
        call: orders-change-order-beta.getchangehistory
        with:
          an: rest.an
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          changeOrderId: rest.changeOrderId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/order-system/orders/{changeorderid}/changes/preview
      name: api-order-system-orders-changeorderid-changes-preview
      description: REST surface for api-order-system-orders-changeOrderId-changes-preview.
      operations:
      - method: POST
        name: previewchange
        description: VTex Preview order change
        call: orders-change-order-beta.previewchange
        with:
          an: rest.an
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          changeOrderId: rest.changeOrderId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/order-system/orders/{changeorderid}/changes/{changerequestid}
      name: api-order-system-orders-changeorderid-changes-changerequestid
      description: REST surface for api-order-system-orders-changeOrderId-changes-changeRequestId.
      operations:
      - method: GET
        name: getchangedetail
        description: VTex Get order change details
        call: orders-change-order-beta.getchangedetail
        with:
          an: rest.an
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          changeOrderId: rest.changeOrderId
          changeRequestId: rest.changeRequestId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/order-system/orders/{changeorderid}/changes/{changerequestid}/cancel
      name: api-order-system-orders-changeorderid-changes-changerequestid-cancel
      description: REST surface for api-order-system-orders-changeOrderId-changes-changeRequestId-cancel.
      operations:
      - method: POST
        name: cancelchangestoppedonerror
        description: VTex Cancel order change
        call: orders-change-order-beta.cancelchangestoppedonerror
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          an: rest.an
          changeOrderId: rest.changeOrderId
          changeRequestId: rest.changeRequestId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/order-system/orders/{changeorderid}/changes/{changerequestid}/retry
      name: api-order-system-orders-changeorderid-changes-changerequestid-retry
      description: REST surface for api-order-system-orders-changeOrderId-changes-changeRequestId-retry.
      operations:
      - method: POST
        name: retrychange
        description: VTex Retry order change
        call: orders-change-order-beta.retrychange
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          an: rest.an
          changeOrderId: rest.changeOrderId
          changeRequestId: rest.changeRequestId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-change-order-beta-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Orders API — Change Order (Beta). One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-create-order-change
      description: VTex Create order change
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: orders-change-order-beta.createchange
      with:
        an: tools.an
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        changeOrderId: tools.changeOrderId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-order-change-history
      description: VTex Get order change history
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-change-order-beta.getchangehistory
      with:
        an: tools.an
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        changeOrderId: tools.changeOrderId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-preview-order-change
      description: VTex Preview order change
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-change-order-beta.previewchange
      with:
        an: tools.an
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        changeOrderId: tools.changeOrderId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-order-change-details
      description: VTex Get order change details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-change-order-beta.getchangedetail
      with:
        an: tools.an
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        changeOrderId: tools.changeOrderId
        changeRequestId: tools.changeRequestId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-cancel-order-change
      description: VTex Cancel order change
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-change-order-beta.cancelchangestoppedonerror
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        an: tools.an
        changeOrderId: tools.changeOrderId
        changeRequestId: tools.changeRequestId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-retry-order-change
      description: VTex Retry order change
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-change-order-beta.retrychange
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        an: tools.an
        changeOrderId: tools.changeOrderId
        changeRequestId: tools.changeRequestId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.