ShipStation V1 API — Warehouses

naftiko: 1.0.0-alpha2
info:
  label: ShipStation V1 API — Warehouses
  description: 'ShipStation V1 API — Warehouses. 5 operations. Lead operation: List Warehouses. Self-contained Naftiko capability
    covering one Shipstation business surface.'
  tags:
  - Shipstation
  - Warehouses
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIPSTATION_API_KEY: SHIPSTATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-warehouses
    baseUri: https://ssapi.shipstation.com
    description: ShipStation V1 API — Warehouses business capability. Self-contained, no shared references.
    resources:
    - name: warehouses
      path: /warehouses
      operations:
      - name: listwarehouses
        method: GET
        description: List Warehouses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createwarehouse
        method: POST
        description: Create Warehouse
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: warehouses-warehouseId
      path: /warehouses/{warehouseId}
      operations:
      - name: getwarehouse
        method: GET
        description: Get Warehouse
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: warehouseId
          in: path
          type: integer
          required: true
      - name: updatewarehouse
        method: PUT
        description: Update Warehouse
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: warehouseId
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletewarehouse
        method: DELETE
        description: Delete Warehouse
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: warehouseId
          in: path
          type: integer
          required: true
    authentication:
      type: basic
      username: '{{env.SHIPSTATION_USER}}'
      password: '{{env.SHIPSTATION_PASS}}'
  exposes:
  - type: rest
    namespace: v1-warehouses-rest
    port: 8080
    description: REST adapter for ShipStation V1 API — Warehouses. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/warehouses
      name: warehouses
      description: REST surface for warehouses.
      operations:
      - method: GET
        name: listwarehouses
        description: List Warehouses
        call: v1-warehouses.listwarehouses
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createwarehouse
        description: Create Warehouse
        call: v1-warehouses.createwarehouse
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/warehouses/{warehouseid}
      name: warehouses-warehouseid
      description: REST surface for warehouses-warehouseId.
      operations:
      - method: GET
        name: getwarehouse
        description: Get Warehouse
        call: v1-warehouses.getwarehouse
        with:
          warehouseId: rest.warehouseId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatewarehouse
        description: Update Warehouse
        call: v1-warehouses.updatewarehouse
        with:
          warehouseId: rest.warehouseId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletewarehouse
        description: Delete Warehouse
        call: v1-warehouses.deletewarehouse
        with:
          warehouseId: rest.warehouseId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-warehouses-mcp
    port: 9090
    transport: http
    description: MCP adapter for ShipStation V1 API — Warehouses. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-warehouses
      description: List Warehouses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-warehouses.listwarehouses
      outputParameters:
      - type: object
        mapping: $.
    - name: create-warehouse
      description: Create Warehouse
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-warehouses.createwarehouse
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-warehouse
      description: Get Warehouse
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-warehouses.getwarehouse
      with:
        warehouseId: tools.warehouseId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-warehouse
      description: Update Warehouse
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-warehouses.updatewarehouse
      with:
        warehouseId: tools.warehouseId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-warehouse
      description: Delete Warehouse
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-warehouses.deletewarehouse
      with:
        warehouseId: tools.warehouseId
      outputParameters:
      - type: object
        mapping: $.