BigCommerce Orders V3 — Order Settings

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Orders V3 — Order Settings
  description: 'BigCommerce Orders V3 — Order Settings. 4 operations. Lead operation: BigCommerce Get Global Order Settings.
    Self-contained Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Order Settings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: orders-order-settings
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v3
    description: BigCommerce Orders V3 — Order Settings business capability. Self-contained, no shared references.
    resources:
    - name: orders-settings
      path: /orders/settings
      operations:
      - name: getglobalordersettings
        method: GET
        description: BigCommerce Get Global Order Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateglobalordersettings
        method: PUT
        description: BigCommerce Update Global Order Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: orders-settings-channels-channel_id
      path: /orders/settings/channels/{channel_id}
      operations:
      - name: getchannelordersettings
        method: GET
        description: BigCommerce Get Channel Order Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatechannelordersettings
        method: PUT
        description: BigCommerce Update Channel Order Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.BIGCOMMERCE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: orders-order-settings-rest
    port: 8080
    description: REST adapter for BigCommerce Orders V3 — Order Settings. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/orders/settings
      name: orders-settings
      description: REST surface for orders-settings.
      operations:
      - method: GET
        name: getglobalordersettings
        description: BigCommerce Get Global Order Settings
        call: orders-order-settings.getglobalordersettings
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateglobalordersettings
        description: BigCommerce Update Global Order Settings
        call: orders-order-settings.updateglobalordersettings
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/settings/channels/{channel-id}
      name: orders-settings-channels-channel-id
      description: REST surface for orders-settings-channels-channel_id.
      operations:
      - method: GET
        name: getchannelordersettings
        description: BigCommerce Get Channel Order Settings
        call: orders-order-settings.getchannelordersettings
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatechannelordersettings
        description: BigCommerce Update Channel Order Settings
        call: orders-order-settings.updatechannelordersettings
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-order-settings-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Orders V3 — Order Settings. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: bigcommerce-get-global-order-settings
      description: BigCommerce Get Global Order Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-order-settings.getglobalordersettings
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-update-global-order-settings
      description: BigCommerce Update Global Order Settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: orders-order-settings.updateglobalordersettings
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-get-channel-order-settings
      description: BigCommerce Get Channel Order Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-order-settings.getchannelordersettings
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-update-channel-order-settings
      description: BigCommerce Update Channel Order Settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: orders-order-settings.updatechannelordersettings
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.